GET
/
payment-instruments
List saved payment methods
curl --request GET \
  --url https://api.sandbox.primer.io/payment-instruments \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>'
{
  "data": [
    {
      "createdAt": "2021-03-01T12:00:00.123456",
      "token": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5",
      "tokenType": "MULTI_USE",
      "analyticsId": "vuXhpZouWxaZpRZ-x_brZmtT",
      "paymentMethodType": "PAYMENT_CARD",
      "payment_method_data": {
        "last4Digits": "1111",
        "expirationMonth": "12",
        "expirationYear": "2030",
        "cardholderName": "John Biggins",
        "network": "Visa",
        "networkTransactionId": 20210628190752,
        "accountFundingType": "DEBIT"
      },
      "customerId": "customer-123",
      "description": "My first card",
      "deleted": false,
      "default": true
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Headers

X-API-VERSION
string
required

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

Example:

"2.4"

Query Parameters

customer_id
string
required

Return payment methods for this customer ID.

Response

200 - application/json

Successful Response

The response is of type object.