Retrieving mandates for a payment method

If you have multiple mandates associated with a payment method, you can send a GET request to /v1/payment-methods/{paymentMethodId}/mandates endpoint of the payment methods API. You use this endpoint to get a list of all the mandates associated with your customer’s payment card. For example, if your customer uses a payment card for both a catering order and for a weekly subscription, send a GET request to retrieve the mandates for the payment card. Include the paymentMethodId in the request path. For more information, see Getting a list of payment methods attached to a customer record.

Example response body

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  (1) 
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
    "originalTransactionId": "b11ac1d7-0e90-4b3e-a083-e5c767d08597", (2)
    "standingInstructionType": "INSTALLMENT", (3) 
    "status": "ACTIVE",   (4)
    "createdAt": "2019-08-24T14:15:22Z", (5)
    "externalReferenceId": null (6)
    } 
    {
    "id": "f20fc095-1278-45d4-bc11-84baf7c44547",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
    "originalTransactionId": "35022a54-c201-4877-b2b2-8625faedc5fe",
    "standingInstructionType": "RECURRING",
    "status": "ACTIVE",
    "createdAt": "2019-08-24T14:15:22Z", 
}

• (1):

  The unique identifier of mandate.

• (2):

  The identifier of the original transaction that established the customer consent to authorize the payment card to be used for merchant-initiated transactions.

• (3):

  The standingInstructionType associated with the mandateId. This indicates the instruction type used by the merchant and sent to the payment processor.

• (4):

  The status of the mandate. The status is either ACTIVE or INACTIVE.

  • ACTIVE: The mandate can be used to initiate a payment.

  • INACTIVE: The mandate can no longer be used to initiate a payment.

• (5):

  The date and time the mandate was created and the customer consented to authorize the payment card to be used for merchant-initiated transactions in ISO 8601 format.

• (6):

  The optional reference identifier for the consent agreement language. If using the default consent agreement language, this value can be null.