Thanks for being patient while we implement your feedback to improve the developer experience.

Orders V3

Manage order settings of BigCommerce stores.

Get Transactions

GET /orders/{order_id}/transactions

Request

Returns an order's transactions.

Usage Notes

  • Depending on the payment method, different information will be available (not all payment gateways return full card or fraud detail).

Requires at least one of the following scopes:

  • store_v2_transactions_read_only
  • store_v2_transactions

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • order_id in path - integer - required

    The ID of the Order to which the transactions belong.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/orders/[order_id]/transactions' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Response payload for the BigCommerce Order Transactions API.

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
  "data": [
    {
      "event": "purchase",
      "method": "credit_card",
      "amount": 0,
      "currency": "string",
      "gateway": "2checkout",
      "gateway_transaction_id": "string",
      "date_created": "2019-08-24T14:15:22Z",
      "test": true,
      "status": "ok",
      "fraud_review": true,
      "reference_transaction_id": 0,
      "offline": {
        "display_name": "string"
      },
      "custom": {
        "payment_method": "string"
      },
      "payment_method_id": "string",
      "id": 0,
      "order_id": "string",
      "payment_instrument_token": "string",
      "avs_result": {
        "code": "string",
        "message": "string",
        "street_match": "string",
        "postal_match": "string"
      },
      "cvv_result": {
        "code": "string",
        "message": "string"
      },
      "credit_card": {
        "card_type": "alelo",
        "card_iin": "string",
        "card_last4": "string",
        "card_expiry_month": 1,
        "card_expiry_year": 0
      },
      "gift_certificate": {
        "code": "MB345",
        "original_balance": 100,
        "starting_balance": 100,
        "remaining_balance": 35.42,
        "status": "active"
      },
      "store_credit": {
        "remaining_balance": 35.42
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}