SUsumup
Customers

List payment instruments

Changed on

Lists all payment instrument resources that are saved for an identified customer.

get/v0.1/customers/{customer_id}/payment-instruments

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/customers/{customer_id}/payment-instruments
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: payment_instruments, customers.read

Response

Returns the list of saved payment instruments for the customer.

tokenstring

Token identifying the customer's saved payment card. Pass it as token, together with the associated customer_id and payment_type = card, when processing a checkout with this instrument.

activeboolean

Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a DELETE request to the resource endpoint.

type'card'

Type of the payment instrument.

created_atstring date-time

The timestamp of when the payment instrument was created.

Example response

[
  {
    "token": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3",
    "active": true,
    "type": "card",
    "mandate": {
      "type": "recurrent",
      "status": "active",
      "merchant_code": "MH4H92C7"
    },
    "card": {
      "last_4_digits": "0001",
      "type": "VISA"
    },
    "created_at": "2021-03-30T10:06:07.000+00:00"
  }
]

Changes

  • fddb4ef1245aRevision changes
    • warning

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

  • 0f66b0a52002Revision changes
    • warning

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