Payment Methods API

List saved payment methods

Retrieve a list of stored payment methods for a customer.

get/payment-instruments

Query parameters

customer_idstring required

Return payment methods for this customer ID.

Headers

X-API-VERSIONstring required

Example:2.4

Specifies the version of the API to use. This must be set to 2.4.

Response

Successful Response

Example response

{
  "data": [
    {
      "createdAt": "2021-03-01T12:00:00.123456",
      "token": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5",
      "tokenType": "MULTI_USE",
      "analyticsId": "vuXhpZouWxaZpRZ-x_brZmtT",
      "paymentMethodType": "PAYMENT_CARD",
      "paymentMethodData": {
        "last4Digits": "1111",
        "expirationMonth": "12",
        "expirationYear": "2030",
        "cardholderName": "John Biggins",
        "network": "Visa",
        "networkTransactionId": "020210628190752",
        "accountFundingType": "DEBIT"
      },
      "customerId": "customer-123",
      "description": "My first card",
      "deleted": false,
      "default": true
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.