Get All Transactions

get

https://openapi.sandbox.xenithpay.com/v1/transactions

Returns a single, cursor-paginated feed over all seven transaction types on your account: PAY_IN, PAY_OUT, SETTLEMENT, TOP_UP, PAY_IN_CREDIT, BALANCE_ADJUSTMENT, and PAYMENT_LINK. Use it for browsing, reconciling and syncing your transaction history.

page.snapshotAt is the time the response was generated, not a completeness watermark — there is no ingestion watermark, so data is complete only up to approximately snapshotAt minus replication delay. To sync a local copy, poll with createdTimeGte set to a lookback margin wider than the replication delay and dedupe results on id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

transactionTypes

array of strings

length ≤ 100

Filters by transaction type. Accepts repeated keys (?transactionTypes=PAY_IN&transactionTypes=PAY_OUT) and/or comma-separated values (?transactionTypes=PAY_IN,PAY_OUT) — the two forms can also be combined.

transactionTypes

Allowed:

statuses

array of strings

length ≤ 100

Filters by status. Accepts repeated keys and/or comma-separated values, same as transactionTypes. PENDING_APPROVAL is distinct from PENDING for a pay-out awaiting internal approval. A PAYMENT_LINK item reports its own native status (ACTIVE, COMPLETED, or EXPIRED) rather than a pay-in-derived status — statuses=SUCCESS will not match a finished payment link, use statuses=COMPLETED.

statuses

currency

array of strings

length ≤ 100

Filters by ISO 4217 three-letter currency code. Despite the singular name, this parameter accepts repeated keys and/or comma-separated values. Values are not validated against ISO 4217 — an unrecognized code simply matches nothing.

currency

paymentMethods

array of strings

length ≤ 100

Filters by payment method code. Accepts repeated keys and/or comma-separated values. Case-sensitive and not validated against any list of known channels. Refer to Pay In Channels and Pay Out Channels for the method code list.

paymentMethods

paymentChannels

array of strings

length ≤ 100

Filters by payment channel code. Accepts repeated keys and/or comma-separated values. Case-sensitive and not validated against any list of known channels — an unknown or wrongly-cased channel simply matches nothing and returns 200 with fewer rows. Refer to Pay In Channels and Pay Out Channels for the channel code list.

paymentChannels

referenceCode

string

Filters by the merchant-provided reference code. Exact match, case-sensitive.

string

Filters by the exact source record id (not a pagination cursor).

createdTimeGte

date-time

Filters transactions created on or after this time, RFC 3339 format (UTC+0).

createdTimeLte

date-time

Filters transactions created on or before this time, RFC 3339 format (UTC+0). A value before createdTimeGte is rejected with 400.

sortOrder

string

enum

Defaults to desc

Sort order. Defaults to desc. The server also accepts uppercase values, but use the lowercase values shown here.

Allowed:

limit

integer

1 to 100

Defaults to 50

Maximum number of records to return. Out-of-range values are rejected with 400, not clamped.

afterId

string

Opaque cursor: returns records after this position. Mutually exclusive with beforeId — sending both is a 400. Use the page.nextCursor value from a previous response; do not construct it yourself.

beforeId

string

Opaque cursor: returns records before this position. Mutually exclusive with afterId — sending both is a 400. Use the page.previousCursor value from a previous response; do not construct it yourself.

Headers

Xenith-Api-Key

string

required

API Key will be delivered to you by email

Xenith-Request-Timestamp

string

required

ISO 8601 date time format, should be in (UTC+0)

Xenith-Request-Signature

string

required

Refer to page Build Signature and Set Headers for instructions on how to build a signature

Responses

200Successfully retrieved the transactions list.

403The API key is valid but lacks the TRANSACTION product read permission. Grant that permission on the key rather than rotating it. See the Get All Transactions Errors dictionary for more detail.

500An unexpected server error occurred. Wait briefly and retry. If the error persists after multiple attempts, contact support. Retrying is safe for this GET operation. See the Get All Transactions Errors dictionary for more detail.