Payments API - Hands-on Lab

Payments API

The Payments API enables you to process payments through the store’s connected payment gateway. A payment can be taken for an order that is created using either the Server to Server Checkout API Orders endpoint or creating an order using V3 orders endpoint.

In this lab, you will:

• Create a payment access token
• Get payment methods
• Process payment for an order
• Get all store payment methods

Prerequisites

• BigCommerce store (sandbox or live)
• API credentials for the store
• REST client (Postman)
• Configure a payment gateway in your store’s payment settings, such as Braintree, PayPal, or Stripe.

Get Payment Methods for an Order

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/payments/methods?order_id={order_id}

2. Replace {order_id} with an order ID
3. Select GET next to the request url
4. Click the Send button
5. Observe response and a list of payment methods

Create a Payment Access Token

1. Copy and paste the request below into Postman

https://api.bigcommerce.com/stores/{{store_hash}}/v3/payments/access_tokens

2. Copy and paste the code below into the body section of Postman

{
    "order": {
    "id": {order_id}
    }
}

3. Replace {order_id} with an order ID
4. Select POST next to the request url
5. Click the Send button
6. Observe response and copy the payment access token

Process a Credit Card Payment for an Order

1. Copy and paste the request below into Postman

https://payments.bigcommerce.com/stores/{{store_hash}}/payments

2. Add the following request headers

3. Copy and paste the code below into the body section of Postman

{
    "payment": {
        "instrument": {
            "type": "card",
            "number": "4111111111111111",
            "cardholder_name": "Jane",
            "expiry_month": 12,
            "expiry_year": 2024,
            "verification_value": "411"
        },
        "payment_method_id": "testgateway.card"
    }
}

4. Select POST next to the request URL
5. Click the Send button
6. Observe response