Get customer's mandate
Mandates API

GET
https://api.mollie.nl/v1/customers/customerId/mandates/id
Authentication: API keys OAuth access tokens

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

Parameters

Replace customerId in the endpoint URL by the customer ID, and replace id by the mandate ID. For example: /v1/customers/cst_7UhSN1zuXS/mandates/mdt_4qqhO89gsT.

Includes

Some endpoints allow you to indicate if you want more information to be included in the API response via the include querystring parameter.

  • No includes supported for this endpoint.

Response

200
application/json; charset=utf-8
resource
string

Indicates the response contains a mandate object.

Possible values: mandate

id
string

The mandate's identifier, for example mdt_1234567.

status
string

The status of the mandate.

Possible values: valid pending invalid

method
string

Payment method of the mandate.

Possible values: directdebit creditcard

customerId
string

The customer's unique identifier, for example cst_3RkSN1zuPE.

details
object | null

Mandate details that are different per payment method. Available fields depend on that payment method.

consumerName
string

The direct debit account holder's name.

consumerAccount
string

The direct debit account IBAN.

consumerBic
string

The direct debit account BIC.

cardHolder
string

The credit card holder's name.

cardNumber
string

The last four digits of the credit card number.

cardLabel
string | null

The credit card's label. Note that not all labels can be acquired through Mollie.

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

cardFingerprint
string

Unique alphanumeric representation of credit card, usable for identifying returning customers.

cardExpiryDate
string

Expiry date of the credit card card in YYYY-MM-DD format.

mandateReference
string

Optional – The mandate's custom reference, if this was provided when creating the mandate.

signatureDate
string

Optional – The signature date of the mandate in YYYY-MM-DD format.

createdDatetime
datetime

The mandate's date and time of creation, in ISO 8601 format.

Example

Request code

$customer = $mollie->customers_mandates->withParentId("cst_4qqhO89gsT")
    ->get("mdt_h3gAaD5zP");

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "resource": "mandate",
    "id": "mdt_qtUgejVgMN",
    "status": "valid",
    "method": "creditcard",
    "customerId": "cst_R6JLAuqEgm",
    "details": {
        "cardHolder": "John Doe",
        "cardNumber": "1234",
        "cardLabel": "Mastercard",
        "cardFingerprint": "fHB3CCKx9REkz8fPplT8N4nq",
        "cardExpiryDate": "2016-03-31"
    },
    "createdDatetime": "2016-04-13T11:32:38.0Z"
}