Get mandate

Mandates API v2
GEThttps://api.mollie.com/v2/customers/*customerId*/mandates/*id*
Authentication:API keysOrganization access tokensApp access tokens

Retrieve a mandate by its ID and its customer’s ID. The mandate will either contain IBAN or credit card details, depending on the type of mandate.

Note

Trying to retrieve a revoked mandate will result in a 410 exception.

Parameters

Replace customerId in the endpoint URL by the customer’s ID, and replace id by the mandate’s ID. For example /v2/customers/cst_8wmqcHMN4U/mandates/mdt_pWUnw6pkBN.

Access token parameters

If you are using organization access tokens or are creating an OAuth app, you can enable test mode through the testmode query string parameter.

testmodebooleanoptional

Response

200 application/json

resourcestring
Indicates the response contains a mandate object. Will always contain mandate for this endpoint.
idstring
The identifier uniquely referring to this mandate. Mollie assigns this identifier at mandate creation time. For example mdt_pWUnw6pkBN.
modestring
The mode used to create this mandate.
statusstring

The status of the mandate. Please note that a status can be pending for mandates when the first payment is not yet finalized or when we did not received the IBAN yet.

Possible values: valid pending invalid

methodstring

Payment method of the mandate.

Possible values: directdebit creditcard paypal

detailsobject
The mandate detail object contains different fields per payment method. See the list below.
mandateReferencestring
The mandate’s custom reference, if this was provided when creating the mandate.
signatureDatestring
The signature date of the mandate in YYYY-MM-DD format.
createdAtdatetime
The mandate’s date and time of creation, in ISO 8601 format.
_linksobject

An object with several URL objects relevant to the mandate. Every URL object will contain an href and a type field.

Show child parameters

selfURL object
The API resource URL of the mandate itself.
customerURL object
The API resource URL of the customer the mandate is for.
documentationURL object
The URL to the mandate retrieval endpoint documentation.

Payment method specific details

The mandate detail object contains different fields per payment method.

Direct Debit

consumerNamestring
The account holder’s name.
consumerAccountstring
The account holder’s IBAN.
consumerBicstring
The account holder’s bank’s BIC.

Credit Card

cardHolderstring
The credit card holder’s name.
cardNumberstring
The last four digits of the credit card number.
cardLabelstring

The credit card’s label. Note that not all labels can be processed through Mollie.

Possible values: American Express Carta Si Carte Bleue Dankort Diners Club Discover JCB Laser Maestro Mastercard Unionpay Visa null

cardFingerprintstring
Unique alphanumeric representation of the credit card, usable for identifying returning customers.
cardExpiryDatedate
Expiry date of the credit card in YYYY-MM-DD format.

PayPal

consumerNamestring
The consumer’s first and last name.
consumerAccountstring
The consumer’s email address.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/customers/cst_4qqhO89gsT/mandates/mdt_h3gAaD5zP \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

1
2
3
4
5
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");
$customer = $mollie->customers->get("cst_4qqhO89gsT");
$mandate = $customer->getMandate("mdt_h3gAaD5zP");

1
2
3
4
5
6
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_api_key('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')

mandate = mollie_client.customer_mandates.with_parent_id('cst_4qqhO89gsT').get('mdt_h3gAaD5zP')

1
2
3
4
5
6
7
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
end

mandate = Mollie::Customer::Mandate.get('mdt_h3gAaD5zP', customer_id: 'cst_4qqhO89gsT')

1
2
3
4
5
6
7
8
9
const { createMollieClient } = require('@mollie/api-client');
const mollieClient = createMollieClient({ apiKey: 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM' });

(async () => {
  const mandate = await mollieClient.customers_mandates.get(
    'mdt_h3gAaD5zP',
    { customerId: 'cst_4qqhO89gsT' }
  );
})();

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "mandate",
    "id": "mdt_h3gAaD5zP",
    "mode": "test",
    "status": "valid",
    "method": "directdebit",
    "details": {
        "consumerName": "John Doe",
        "consumerAccount": "NL55INGB0000000000",
        "consumerBic": "INGBNL2A"
    },
    "mandateReference": "YOUR-COMPANY-MD1380",
    "signatureDate": "2018-05-07",
    "createdAt": "2018-05-07T10:49:08+00:00",
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/customers/cst_4qqhO89gsT/mandates/mdt_h3gAaD5zP",
            "type": "application/hal+json"
        },
        "customer": {
            "href": "https://api.mollie.com/v2/customers/cst_4qqhO89gsT",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/mandates-api/get-mandate",
            "type": "text/html"
        }
    }
}