Customers

List payment instruments

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

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

Response

Returns the list of saved payment instruments for the customer.

tokenstring

Unique token identifying the saved payment card for a customer.

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

Changed in 6 of the 53 revisions of this API.149

Jul 10, 2026c75ca16e1e441See the full diff
- ○
  the security scope customers.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 9, 20260cd7388a9eda2See the full diff
- ●
  added the new active enum value to the items/mandate/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new inactive enum value to the items/mandate/status response property for the response status 200
  response-property-enum-value-added
Mar 11, 2026cd79d83b07e025See the full diff
- ●
  removed the optional property error_code from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property message from the response with the 401 status
  response-optional-property-removed
- ○
  added the optional property detail to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property instance to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property title to the response with the 401 status
  response-optional-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 19, 2026e28f194df27e10See the full diff
- ●
  added the new ALELO enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new CONECS enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new EFTPOS enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new GIROCARD enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new INTERAC enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new PLUXEE enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SWILE enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new TICKET enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new VPAY enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new VR enum value to the items/card/type response property for the response status 200
  response-property-enum-value-added
Dec 19, 2025bdda188d36dd1See the full diff
- ○
  the response optional property items/card/type became not read-only for the status 200
  response-optional-property-became-not-read-only
Feb 25, 2025cdadac3315a12See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security oauth2 was added to the API
  api-security-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history