MOmollie
Mandates API

List mandates

Changed on

Retrieve a list of all mandates.

The results are paginated.

get/v2/customers/{customerId}/mandates

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/customers/{customerId}/mandates
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: mandates.read

Query parameters

fromstring
Example:mdt_5B8cwPMGnU

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.

limitinteger nullable
Example:50

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

sort'asc' | 'desc'
Example:desc

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

scopesMandateScopes[]

Returns only mandates that include the specified scopes.

[
  "customer-present"
]
testmodeboolean

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.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of mandate objects.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "mandates": [
      {
        "resource": "mandate",
        "id": "mdt_5B8cwPMGnU",
        "mode": "live",
        "method": "directdebit",
        "consumerName": "John Doe",
        "consumerAccount": "NL55INGB0000000000",
        "consumerBic": "BANKBIC",
        "consumerEmail": "example@email.com",
        "details": {
          "consumerName": "John Doe",
          "consumerAccount": "NL55INGB0000000000",
          "consumerBic": "BANKBIC",
          "cardHolder": "John Doe",
          "cardExpiryDate": "2025-01-01",
          "cardLabel": "Visa",
          "cardFingerprint": "d3290e932k02f"
        },
        "signatureDate": "2025-01-01",
        "mandateReference": "ID-1023892",
        "paypalBillingAgreementId": "B-12A34567B8901234CD",
        "payPalVaultId": "8kk8451t",
        "scopes": [
          "customer-present"
        ],
        "status": "valid",
        "customerId": "cst_5B8cwPMGnU",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "customer": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 34b0d7662c30Revision changes
    • warning

      added the new Cartes Bancaires enum value to the //////// response property for the response status

    • warning

      added the new undefined enum value to the //////// response property for the response status

  • 1bcb76dbe9eaRevision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status