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

1 [
2   {
3     "type": "stored_card",
4     "billing_address": {
5       "first_name": "Tester",
6       "last_name": "Tester",
7       "email": "example@email.com",
8       "company": "Test Company",
9       "address1": "1 Sample Street",
10       "address2": "Apt 1",
11       "city": "Las Vegas",
12       "postal_code": "90854",
13       "state_or_province": "Nevada",
14       "state_or_province_code": "NV",
15       "country_code": "US",
16       "phone": "101-192-0293"
17     },
18     "brand": "VISA",
19     "expiry_month": 1,
20     "expiry_year": 0,
21     "is_default": true,
22     "issuer_identification_number": "411111",
23     "last_4": "1111",
24     "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c"
25   }
26 ]

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

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

1 [
2   {
3     "type": "stored_card",
4     "billing_address": {
5       "first_name": "Tester",
6       "last_name": "Tester",
7       "email": "example@email.com",
8       "company": "Test Company",
9       "address1": "1 Sample Street",
10       "address2": "Apt 1",
11       "city": "Las Vegas",
12       "postal_code": "90854",
13       "state_or_province": "Nevada",
14       "state_or_province_code": "NV",
15       "country_code": "US",
16       "phone": "101-192-0293"
17     },
18     "brand": "VISA",
19     "expiry_month": 1,
20     "expiry_year": 0,
21     "is_default": true,
22     "issuer_identification_number": "411111",
23     "last_4": "1111",
24     "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c"
25   }
26 ]

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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

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