List transactions
Lists transactions for the company in X-On-Behalf-Of, newest first by transaction_at.
Results are limited to the accounts the API key’s member can access.
By default the list excludes future-scheduled payments and the internal reward types
loyalty_out, points_in, points_out, and trophy. Pass type to include a
specific type, or ids / source_payment_ids to look up rows regardless of these defaults.
Use cursor pagination (next_cursor → cursor) for large result sets. Offset pagination
(offset) also returns a total count but cannot be combined with cursor.
Authorizations
Short-lived access token. Obtain with your api_key.
Query Parameters
Comma-separated account UUIDs to include.
Comma-separated ISO 4217 account currencies (for example GBP,EUR).
Comma-separated ISO 4217 currencies the transaction was made in.
Comma-separated transaction UUIDs. Explicit lookups bypass the default type and scheduled exclusions.
Comma-separated identifiers of the payment in the originating source system.
Comma-separated statuses. One or more of pending, completed, declined, reversed.
Comma-separated transaction types. See the type field on the transaction object for values.
Comma-separated directions. One or both of debit, credit.
Comma-separated UUIDs of the users who initiated the transactions.
Comma-separated payee identifiers.
Comma-separated card tokens. Returns card transactions made with those cards.
Comma-separated category UUIDs.
true returns only categorised transactions, false only uncategorised.
Case-insensitive substring match against name and reference.
Inclusive lower bound on transaction_at (RFC 3339).
Inclusive upper bound on transaction_at (RFC 3339). Must not be before from.
Minimum absolute account amount (decimal string).
Maximum absolute account amount (decimal string). Must not be less than account_amount_min.
true returns only payments scheduled for today or later. false (default) excludes them.
true returns only transactions that earned points and adds points_totals_by_day to the response.
Sort field. Defaults to transaction_at.
transaction_at, completed_at, authorized_at, created_at Sort order. Defaults to desc.
asc, desc Page size, 1–200. Defaults to 50.
1 <= x <= 200Opaque next_cursor value from a previous page. Cannot be combined with offset.
Number of rows to skip. Enables the total count. Cannot be combined with cursor.
x >= 0true includes a user object (name and avatar) on each transaction that has a user_id.
true includes a card object (name, last four digits, type) on each card transaction.
Response
One page of transactions.
Transactions for the current page.
Opaque cursor for the next page. Omitted on the last page or when using offset.
Total matching transactions. Present only when offset is supplied.
Present only when earned_points=true. Points earned per day for the current page.