List Instruments

Beta

GET

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

GET

/stores/:store_hash/v3/payments/stored-instruments

curl https://api.bigcommerce.com/stores/store_hash/v3/payments/stored-instruments \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "billing_address": {
        "address1": "1 Sample Street",
        "address2": "",
        "city": "",
        "company": "",
        "country_code": "US",
        "email": "example@email.com",
        "first_name": "Tester",
        "last_name": "Tester",
        "phone": "101-192-0293",
        "postal_code": "55555",
        "state_or_province": "Nevada",
        "state_or_province_code": "NV"
      },
      "brand": "visa",
      "customer_id": 1,
      "expiry_month": 1,
      "expiry_year": 1,
      "iin": "411111",
      "is_default": true,
      "last_4": "1111",
      "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c",
      "type": "credit_card"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "",
        "current": "",
        "next": ""
      }
    },
    "cursor_pagination": {
      "count": 1,
      "per_page": 1,
      "start_cursor": "",
      "end_cursor": "",
      "links": {
        "previous": "",
        "next": ""
      }
    }
  }
}

Lists all available stored instruments for a store. 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
Create Payments	create	`store_payments_access_token_create`
Get Payment Methods	read-only	`store_payments_methods_read`

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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

pageintegerOptional

The requested page.

limitintegerOptional

The maximum number of results.

afterstringOptional

The cursor reference of the last entry for the previous page. Use the end_cursor value from the last response to get the next page (end_cursor is only returned on the first page or when the request contains query parameter before or after). For example after=ODc%3D.

beforestringOptional

The cursor reference of the first entry for the next page. Use the start_cursor value from the last response to get the previous page (start_cursor is only returned on the first page or when the request contains query parameter before or after). For example before=ODg%3D.

Response

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals. Both pagination and cursor_pagination would be returned on the first page. Only pagination will be returned when you provide the page parameter, which is greater than the first page. Only cursor_pagination would be returned when you provide the before or after parameters in the request that are greater than the first page.

Errors

401

Unauthorized Error