List mandates

get

https://api.mollie.com/v2/customers/{customerId}/mandates

Retrieve a list of all mandates.

The results are paginated.

🔑
Access with
API key Advanced access token with mandates.readOAuth access with mandates.read

Path Params

customerId

string

required

Provide the ID of the related customer.

Query Params

from

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

integer | null

1 to 250

Defaults to 50

The maximum number of items to return. Defaults to 50 items.

sort

string

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

scopes

array of strings

Returns only mandates that include the specified scopes.

Show Details

customer-present	Indicates the mandate can be used for payments where the customer is present (e.g., "one-click" payments with a saved card).
customer-not-present	Indicates the mandate can be used for Merchant-Initiated Transactions (MIT), such as recurring payments or subscriptions, where the customer is not present.

scopes

testmode

boolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. 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.

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/hal+json

200A list of mandate objects.

400The request contains issues. For example, if the specified from value is not a valid ID.

404No entity with this ID exists.

429Rate Limit has been reached.