List Transactions

GET

https://api.bigcommerce.com/stores/:store_hash/v3/orders/:order_id/transactions

GET

/stores/:store_hash/v3/orders/:order_id/transactions

curl https://api.bigcommerce.com/stores/store_hash/v3/orders/1/transactions \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "event": "purchase",
      "method": "credit_card",
      "amount": 1.1,
      "currency": "string",
      "gateway": "2checkout",
      "gateway_transaction_id": "string",
      "test": true,
      "status": "ok",
      "fraud_review": true,
      "reference_transaction_id": 1,
      "offline": {
        "display_name": "string"
      },
      "custom": {
        "payment_method": "string"
      },
      "payment_method_id": "string",
      "id": 1,
      "order_id": "string",
      "date_created": "2024-01-15T09:30:00Z",
      "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": 1
      },
      "gift_certificate": {
        "code": "MB345",
        "original_balance": 100,
        "starting_balance": 100,
        "remaining_balance": 35.42,
        "status": "active"
      },
      "store_credit": {
        "remaining_balance": 35.42
      },
      "custom_provider_field_result": {
        "receipt_number": "string",
        "authorization_code": "string",
        "fraud_response": "string",
        "amount_received": 1.1
      },
      "provider_instrument_token": "string",
      "provider_customer_id": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

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-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Transactions	read and modify `transactions` and `payment_methods`	`store_v2_transactions`
Order Transactions	read `transactions` and `payment_methods`	`store_v2_transactions_read_only`
Orders	read and modify `payment_methods`	`store_v2_orders`
Orders	read `payment_methods`	`store_v2_orders_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

order_idintegerRequired

The ID of the Order to which the transactions belong.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

Response payload for the BigCommerce Order Transactions API.

datalist of objectsOptional

metaobjectOptional

Errors

404

Not Found Error

503

Service Unavailable Error