Stored Instruments API (Beta) - Stores V3 Server Operations

API proxy part of Stored Instruments API.

Create Instrument Access Token

POST /payments/stored-instruments/access-tokens

Request

Creates a token.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Response

Created token.

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"access_token": "IAT eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MTUyNTA3NTksIm5iZiI6MTYxNTI0Nz E1OSwiaXNzIjoicGF5bWVudHMuYmlnY29tbWVyY2UuY29tIiwic3ViIjoieHNsM3 JoZGYzNiIsImp0aSI6IjNhOGE3NTJjLTBmNWQtNDNmNS05MzdjLTRhMTYzODBlMW YwZCIsImlhdCI6MTYxNTI0NzE1OSwiZGF0YSI6eyJzdG9yZV9pZCI6IjEwMDEzMz YzMjQiLCJvcmRlcl9pZCI6IjE2NiIsImFtb3VudCI6NDU3OTAsImN1cnJlbmN5Ij oiVVNEIn19.dpCDgOfbNrz095VARY20yYBRTOuq-W1F0ETTgf1Zhbs",
"expires_at": 1681283841
},
"meta": {}
}

List Available Payment Method IDs

GET /payments/stored-instruments/methods

Request

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.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • currency_code in query - string
    required
    The store hash.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/payments/stored-instruments/methods' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
"data": [
{
"method_id": "braintree.credit_card",
"name": "Credit card",
"test_mode": false,
"type": "credit_card",
"supported_instruments": [
"raw_card"
]
}
],
"meta": {}
}
Did you find what you were looking for?