bc-payments

BigCommerce Payment Integration

Before writing code

Fetch live docs:

1. Fetch https://docs.bigcommerce.com/developer/api-reference/rest/admin/payments for the Payments API reference
2. Web-search site:developer.bigcommerce.com payments processing api for Payment Processing API
3. Web-search bigcommerce payment methods api configuration for payment method management

Payment Architecture

How Payments Work in BigCommerce

BigCommerce handles payment gateway connections:

• Admin-Configured — merchants configure payment providers (Stripe, PayPal, Square, etc.) in the BigCommerce admin
• Native Checkout — payment gateway integration is built into BigCommerce checkout
• Headless/API — use the Payment Processing API to process payments server-side

Payment Flow (Headless)

1. Create cart → checkout → order via API
2. Get accepted payment methods: GET /v3/payments/methods
3. Create payment access token: POST /v3/payments/access_tokens
4. Process payment: POST https://payments.bigcommerce.com/stores/{hash}/payments

Payment Processing API

Get Payment Methods

GET /v3/payments/methods?order_id={id} — returns accepted methods for an order:

{
  "data": [
    {
      "id": "stripe.card",
      "name": "Stripe",
      "supported_instruments": [
        { "instrument_type": "VISA", "verification_value_required": true }
      ],
      "test_mode": false,
      "type": "CARD"
    }
  ]
}

Create Payment Access Token

POST /v3/payments/access_tokens:

{
  "order": { "id": 12345 }
}

Returns a single-use access token for the Payments endpoint.

Process Payment

POST https://payments.bigcommerce.com/stores/{hash}/payments

Headers:

• Authorization: PAT {payment_access_token}
• Content-Type: application/json

{
  "payment": {
    "instrument": {
      "type": "card",
      "number": "4111111111111111",
      "expiry_month": 12,
      "expiry_year": 2025,
      "name": "John Doe",
      "verification_value": "123"
    },
    "payment_method_id": "stripe.card"
  }
}