Skip to main content

List Transactions

GET 
/v1/transactions

List every transaction visible to the authenticated principal. Combine filters freely — each filter narrows the result set with AND semantics.

Required permission: orders_read.

Request​

Query Parameters

    items integer

    Possible values: >= 1 and <= 100

    id uuid

    Filter by transaction UUID.

    order_id uuid

    Filter to transactions attached to this order.

    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.

    source_type TransactionType

    Possible values: [internet, merchant, moto]

    retrieval_reference RetrievalReferenceNumber
    stan Stan
    auth_code AuthorizationCode
    response_code ResponseCode
    sub_merchant_id string
    issuer string
    card_type string
    country Country

    Possible values: Value must match regular expression ^[A-Z]{2}$

    scheme Scheme

    Possible values: [visa, mastercard, mada, amex]

    month integer

    Possible values: >= 1 and <= 12

    Filter by card expiry month (1–12).

    year integer

    Filter by four-digit card expiry year.

    amount[gte] integer

    Minimum transaction amount (inclusive, minor units).

    amount[lte] integer

    Maximum transaction amount (inclusive, minor units).

    created_at[gte] date-time
    created_at[lte] date-time
    updated_at[gte] date-time
    updated_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.

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