Docs
Management API
Order transactions

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

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: {{token}}'

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.1,
"currency": "string",
"gateway": "2checkout",
"gateway_transaction_id": "string",
"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",
"date_created": "2019-08-24T14:15:22Z",
"payment_instrument_token": "string",
"avs_result": {
"code": "string",
"message": "string",

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get All Order TaxesGet Transactions