Payment Access Token

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

BigCommerce payments requests require a Payment Access Token, or PAT, which is a single use BigCommerce-generated JWT that's tied to the particular order for which the shopper authorizes BigCommerce to submit a payment.

To get a valid PAT, submit the order number to the Create a Payment Access Token endpoint. Authenticate using an API account access token with the Create payments scope as the value of the X-Auth-Token header.

You can also generate a PAT during checkout by using the completeCheckout mutation in the GraphQL Storefront API.

For a guide through the API call sequence needed to create a PAT and make charges, see the Payments Overview.

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
• Process payments
• Get a customer's stored instruments