The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Accept

The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.

Content-Type

The instrument types that supported the method.

Identifies whether this stored instrument is default for the customer.

An identifier representing this stored instrument.

The parameters for an already vaulted Bank account instrument.

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

Total number of items in the collection response.

A string representing the cursor reference to the last item of the current page in the collection.

The amount of items returned in the collection per page, controlled by the limit parameter.

A string representing the cursor reference to the starting item of the current page in the collection.

Pagination links for the previous and next parts of the whole collection.

The link to the current page is returned in the response.

The link to the next page is returned in the response.

The link to the previous page is returned in the response.

Data about the response, including pagination and collection totals.

The page you are currently on within the collection.

The total number of pages in the collection.

The parameters for an already vaulted PayPal instrument.

The error title describing the particular error.

The Instruments Access Token (IAT) for the payments API.

The expiration time as an integer number of seconds since the Epoch.

Identifier for the payment method that will be used for this instrument is obtained from the Payment Methods API.

The trusted shipping address for an instrument.

number of items we were unable to process

Bulk response meta

Response meta

### OAuth scopes

| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
|  Stored Payment Instruments | read-only | `store_stored_payment_instruments_read_only` |
|  Stored Payment Instruments | modify | `store_stored_payment_instruments` |

### 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](/docs/start/authentication/api-accounts). |

### Further reading

For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests).

For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes).

For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).

X-Auth-Token

BigCommerce

API proxy part of Stored Instruments API.

Stored Instruments API (Beta) - Stores V3 Server Operations

Deletes instruments from the store without triggering deletion on the provider side.

token:in

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

page

limit

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`.

after

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`.

before

Imports instruments that were vaulted outside the store.

All instruments were successfully imported.

Updates an instrument in store and can update billing address in the provider's vault.
As of this writing, only the Braintree gateway supports updating customer billing addresses.
If billing_address is included in the request, an attempt will be made to update the billing address at provider's vault.


Lists all available payment method IDs that support stored instruments. This list will include all types of stored instruments namely card, account, and bank_account instruments.

currency_code

Deletes instrument from store and provider's vault.

instrument_token

Failed to load configuration / Invalid configuration.

Stored Instruments API (Beta) - Stores V3 Server Operations

Create Instrument Access Token

Request

Authentication

Parameters

Response

Body

dataobject

metaobject

example

List Available Payment Method IDs

Request

Authentication

Parameters

example

Response

Body

dataarray[object]

metaobject

example