Docs
Management API
Customers V3
Stored Instruments

Stored Instruments

Get Stored Instruments

GET /customers/{customerId}/stored-instruments

Request

Lists all available stored instruments for a customer. This list will include all types of stored instruments namely card, account and bank_account instruments

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • customerId in path - integer
    required
    The ID of the customer.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/customers/[customerId]/stored-instruments' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

array | application/json
One of:

  • type    string

    Type of instrument.

    Allowed: stored_card

  • token    string

    An identifier representing this stored instrument.
    Example: 84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c

  • is_default    boolean

    Identifies whether this stored instrument is default for the customer.

  • brand    string

    Card brand.
    Example: VISA

  • expiry_month    integer

    Expiry month for this card.
    Min: 1
    Max: 12

  • expiry_year    integer

    Expiry year for this card.

  • issuer_identification_number    string

    Issuer identification number for this card.
    Example: 411111

  • last_4    string

    Last four digits of this card.
    Example: 1111

  • billing_address    object

example-1

[
{
"type": "stored_card",
"token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c",
"is_default": true,
"brand": "VISA",
"expiry_month": 1,
"expiry_year": 0,
"issuer_identification_number": "411111",
"last_4": "1111",
"billing_address": {
"first_name": "Tester",
"last_name": "Tester",
"email": "example@email.com",
"company": "Test Company",
"address1": "1 Sample Street",
"address2": "Apt 1",
"city": "Las Vegas",
"postal_code": "90854",
"state_or_province": "Nevada",
"state_or_province_code": "NV",
"country_code": "US",
"phone": "101-192-0293"
}
}
Did you find what you were looking for?
Delete Multiple MetafieldsGet Stored Instruments