Skip to main content
GET

Authorizations

Authorization
string
header
required

Short-lived access token. Obtain with your api_key.

Query Parameters

account_ids
string

Comma-separated account UUIDs to include.

account_currencies
string

Comma-separated ISO 4217 account currencies (for example GBP,EUR).

transaction_currencies
string

Comma-separated ISO 4217 currencies the transaction was made in.

ids
string

Comma-separated transaction UUIDs. Explicit lookups bypass the default type and scheduled exclusions.

source_payment_ids
string

Comma-separated identifiers of the payment in the originating source system.

status
string

Comma-separated statuses. One or more of pending, completed, declined, reversed.

type
string

Comma-separated transaction types. See the type field on the transaction object for values.

direction
string

Comma-separated directions. One or both of debit, credit.

user_ids
string

Comma-separated UUIDs of the users who initiated the transactions.

payee_ids
string

Comma-separated payee identifiers.

card_tokens
string

Comma-separated card tokens. Returns card transactions made with those cards.

category_ids
string

Comma-separated category UUIDs.

categorized
boolean

true returns only categorised transactions, false only uncategorised.

q
string

Case-insensitive substring match against name and reference.

from
string<date-time>

Inclusive lower bound on transaction_at (RFC 3339).

to
string<date-time>

Inclusive upper bound on transaction_at (RFC 3339). Must not be before from.

account_amount_min
string

Minimum absolute account amount (decimal string).

account_amount_max
string

Maximum absolute account amount (decimal string). Must not be less than account_amount_min.

scheduled
boolean

true returns only payments scheduled for today or later. false (default) excludes them.

earned_points
boolean

true returns only transactions that earned points and adds points_totals_by_day to the response.

sort
enum<string>

Sort field. Defaults to transaction_at.

Available options:
transaction_at,
completed_at,
authorized_at,
created_at
order
enum<string>

Sort order. Defaults to desc.

Available options:
asc,
desc
limit
integer
default:50

Page size, 1–200. Defaults to 50.

Required range: 1 <= x <= 200
cursor
string

Opaque next_cursor value from a previous page. Cannot be combined with offset.

offset
integer

Number of rows to skip. Enables the total count. Cannot be combined with cursor.

Required range: x >= 0
user
boolean

true includes a user object (name and avatar) on each transaction that has a user_id.

card
boolean

true includes a card object (name, last four digits, type) on each card transaction.

Response

One page of transactions.

transactions
Transaction · object[]
required

Transactions for the current page.

next_cursor
string

Opaque cursor for the next page. Omitted on the last page or when using offset.

total
integer

Total matching transactions. Present only when offset is supplied.

points_totals_by_day
object[]

Present only when earned_points=true. Points earned per day for the current page.