rust-mollie-sdk/docs/MandatesApiApi.md

\MandatesApiApi

All URIs are relative to https://api.mollie.com/v2

Method	HTTP request	Description
create_mandate	POST /customers/{customerId}/mandates	Create mandate
get_mandate	GET /customers/{customerId}/mandates/{mandateId}	Get mandate
list_mandates	GET /customers/{customerId}/mandates	List mandates
revoke_mandate	DELETE /customers/{customerId}/mandates/{mandateId}	Revoke mandate

create_mandate

models::MandateResponse create_mandate(customer_id, idempotency_key, mandate_request) Create mandate

Create a mandate for a specific customer. Mandates allow you to charge a customer's card, PayPal account or bank account recurrently. It is only possible to create mandates for IBANs and PayPal billing agreements with this endpoint. To create mandates for cards, your customers need to perform a 'first payment' with their card.

Parameters

Name	Type	Description	Required	Notes
customer_id	String	Provide the ID of the related customer.	[required]
idempotency_key	Option<String>	A unique key to ensure idempotent requests. This key should be a UUID v4 string.
mandate_request	Option<MandateRequest>

Return type

models::MandateResponse

Authorization

apiKey, oAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_mandate

models::MandateResponse get_mandate(customer_id, mandate_id, testmode, idempotency_key) Get mandate

Retrieve a single mandate by its ID. Depending on the type of mandate, the object will contain the customer's bank account details, card details, or PayPal account details.

Parameters

Name	Type	Description	Required	Notes
customer_id	String	Provide the ID of the related customer.	[required]
mandate_id	String	Provide the ID of the related mandate.	[required]
testmode	Option<bool>	Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
idempotency_key	Option<String>	A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Return type

models::MandateResponse

Authorization

apiKey, oAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_mandates

models::ListMandates200Response list_mandates(customer_id, from, limit, sort, testmode, idempotency_key) List mandates

Retrieve a list of all mandates. The results are paginated.

Parameters

Name	Type	Description	Required	Notes
customer_id	String	Provide the ID of the related customer.	[required]
from	Option<String>	Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
limit	Option<i32>	The maximum number of items to return. Defaults to 50 items.
sort	Option<String>	Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
testmode	Option<bool>	Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
idempotency_key	Option<String>	A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Return type

models::ListMandates200Response

Authorization

apiKey, oAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_mandate

serde_json::Value revoke_mandate(customer_id, mandate_id, idempotency_key, delete_webhook_request) Revoke mandate

Revoke a customer's mandate. You will no longer be able to charge the customer's bank account or card with this mandate, and all connected subscriptions will be canceled.

Parameters

Name	Type	Description	Required	Notes
customer_id	String	Provide the ID of the related customer.	[required]
mandate_id	String	Provide the ID of the related mandate.	[required]
idempotency_key	Option<String>	A unique key to ensure idempotent requests. This key should be a UUID v4 string.
delete_webhook_request	Option<DeleteWebhookRequest>

Return type

serde_json::Value

Authorization

apiKey, oAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]