post

/payments

Depending on merchant’s configuration in BigCommerce’s Control Panel, the payment request will be processed as either ‘Authorize only’ or ‘Authorize and Capture’.

If the test payment gateway is enabled on a store, that can also be used during testing.

Payments can be processed using Stored Cards, Payment Tokens or Credit Cards. See Payments API Overview for more.

Payment Access Token:

  • X-Auth-Client
  • X-Auth-Token
  • Content-Type: application/json
  • Accept: application/json

Stored Cards/Credit Card:

  • Content-Type: application/json
  • Accept: application/vnd.bc.v1+json
  • Authorization: PAT a-valid-payment-access-token

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

3 Headers

Request Body

4 Examples
Schema
object
payment
object
required

Responses

Payment has been successfully processed

1 Example
Schema
object
id
string

Identifier for this transaction

transaction_type
string

Transaction type for this payment

2 validations
status
string

Status to indicate a success response

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
store_hash
$$.env
2 variables not set
X-Auth-Client
X-Auth-Token