List Stored Instruments

GET

https://api.bigcommerce.com/stores/:store_hash/v3/customers/:customerId/stored-instruments

GET

/stores/:store_hash/v3/customers/:customerId/stored-instruments

curl https://api.bigcommerce.com/stores/store_hash/v3/customers/1/stored-instruments \
     -H "X-Auth-Token: <apiKey>"

[
  {
    "type": "stored_card",
    "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"
    },
    "brand": "VISA",
    "expiry_month": 1,
    "expiry_year": 0,
    "is_default": true,
    "issuer_identification_number": "411111",
    "last_4": "1111",
    "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c"
  }
]

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-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

customerIdintegerRequired

The ID of the customer.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

stored_cardobject

Details about a stored card instrument which includes details around billing, last 4 digits, issuer, etc.

stored_paypal_accountobject

A PayPal account stored instrument.

stored_bank_accountobject

A stored bank account instrument.

Errors

401

Unauthorized Error

403

Forbidden Error