Payment Processing

The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the Payments Overview.

The Payment Processing API uses BigCommerce's PCI-compliant payments server and a supported payment gateway to charge customers. The payment portal you choose may support charging stored instruments and/or making refund transactions. For a list of compatible payment gateways, as well as a guide through the API call sequence needed to make charges, see the Payments Overview.

A Payment Access Token (PAT) is required to authorize payment processing requests. The X-Auth-Token header is not required in requests to the payment processing endpoint. To generate a PAT, use the Create a Payment Access Token endpoint or the completeCheckout mutation in the GraphQL Storefront API. For a payment processing authentication example request, see the related section in our Authentication article.

Also note that payment processing requests use the BigCommerce Payments Gateway, which uses a different server than our other REST APIs. Please see the server URL for the payment processing endpoint.

To learn more about authenticating Payments endpoints, locate the Authentication section at the top of each endpoint, then click Show Details.

Resources

• Payments Overview
• Process payments authentication example request
• Orders Overview

Webhooks

• Carts (opens in a new tab)
• Orders (opens in a new tab)
• Price list assignment (opens in a new tab)

Additional Payments endpoints

• Get accepted payment methods
• Create a Payment Access Token
• Get a customer's stored instruments