Get Order Transactions

GET 
/v2/orders/:orderID/transactions

Get order transactions

Request

Path Parameters

orderID stringrequired

The unique identifier of the order.

Responses

200

Response Headers

application/json

Schema

Schema

data object[]
Array [
id uuid
The ID of the transaction.
reference string
The payment gateway reference.
name string
A custom name associated with the payment method.
custom_reference string
A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.
gateway string
Possible values: [adyen, authorize_net, braintree, card_connect, cyber_source, elastic_path_payments_stripe, manual, paypal_express_checkout, stripe, stripe_connect, stripe_payment_intents]
The name of the payment gateway used.
amount number
The amount for this transaction.
refunded_amount number
The refunded amount.
currency string
The transaction currency.
transaction-type string
The type of transaction, such as purchase, capture, authorize or refund.
status string
The status provided by the gateway for this transaction, such as complete or failed.
relationships object
order object
data object
type string
Represents the type of the object being returned. It is always order.
id uuid
The ID of the order.
meta object
display_price object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
display_refunded_amount object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
timestamps object
created_at string
The date this was created.
updated_at
The date this was last updated.
]

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "string",
      "name": "string",
      "custom_reference": "string",
      "gateway": "adyen",
      "amount": 0,
      "refunded_amount": 0,
      "currency": "string",
      "transaction-type": "string",
      "status": "string",
      "relationships": {
        "order": {
          "data": {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      },
      "meta": {
        "display_price": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "display_refunded_amount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "timestamps": {
          "created_at": "string"
        }
      }
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...