Skip to navigation
RESTAdminPaymentsStored InstrumentsManage Instruments

Remove Instrument from Store and Gateway

Beta
Deletes instrument from store and provider's vault.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Create Paymentscreatestore_payments_access_token_create
Get Payment Methodsread-onlystore_payments_methods_read

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

instrument_tokenstringRequired
The token that identifies the stored payment instrument.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Response

No Content

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error