API Reference

List mandates

get
https://api.mollie.com/v2/customers//mandates

Retrieve a list of all mandates.

The results are paginated.

Access with

API key

Organization access token with mandates.read

OAuth access with mandates.read

Path Params
string
required

Provide the ID of the related customer.

Query Params
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.

integer | null
1 to 250
Defaults to 50

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

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-presentIndicates the mandate can be used for payments where the customer is present (e.g., "one-click" payments with a saved card).
customer-not-presentIndicates the mandate can be used for Merchant-Initiated Transactions (MIT), such as recurring payments or subscriptions, where the customer is not present.
scopes
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

Updated 17 days ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated 17 days ago