Skip to main content

List Order Transactions

GET 
/v1/orders/:order_id/transactions

List transactions scoped to a single order. Equivalent to calling /v1/transactions?order_id=<order_id> but returns a 404 if the order itself is not visible to the caller.

Required permission: orders_read.

Request​

Path Parameters

    order_id uuidrequired

    Order UUID whose transactions should be listed.

Query Parameters

    items integer

    Possible values: >= 1 and <= 100

    status string[]

    Possible values: [initiated, approved, failed, timeout, system_error]

    Filter by transaction status. Repeat the parameter to match multiple statuses.

    type string[]

    Possible values: [verify, purchase, authorize, capture, void, refund, extension, reversal]

    Filter by transaction type. Repeat the parameter to match multiple types.

    created_at[gte] date-time
    created_at[lte] date-time
    sort[field] string

    Possible values: [status, type, message, stan, reverse_reason, response_code, retrieval_reference, amount, created_at, updated_at]

    Default value: created_at

    sort[dir] string

    Possible values: [asc, desc]

    Default value: desc

Responses​

Paginated list of transactions for the order.

Schema

    transactions object[]required

    meta

    object

    required

    Cursor-style pagination metadata. next_page and prev_page are null at the boundaries. Total counts are intentionally omitted for performance on large result sets (countless pagination).

    current_page integerrequired

    Possible values: >= 1

    next_page integernullablerequired
    prev_page integernullablerequired
Loading...