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

Parameters

  • store_hash in path - string
  • 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

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

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

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example