GET
Search transactions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

programId
string
required

The program to scope results to. Required on every request — including when you pass allPrograms=true. A request without it is rejected before it reaches the search.

allPrograms
enum<string>

When true, widen the search from the single programId to every program your operator role is entitled to. It never reaches beyond your entitlements, and it does not remove the need to send programId. A role with no program entitlement matches nothing rather than everything.

Available options:
true,
false
customerId
string

Filter by customer ID. Comma-separated for multi-select.

custodianId
string

Filter by custodian ID. Comma-separated for multi-select. Ignored for guardian-bound roles, which are always scoped to their own guardian.

keyword
string

Free-text search across indexed fields.

page
integer
default:1

1-based page number. Defaults to 1.

Required range: x >= 1
limit
integer

Maximum number of items per page.

Required range: x >= 1
sortBy
string

Field to sort results by.

sortOrder
enum<string>

Sort direction.

Available options:
asc,
desc
status
string

Filter by status. Comma-separated for multi-select.

fromDate
string<date-time>

Lower bound (inclusive) on record date, ISO 8601.

toDate
string<date-time>

Upper bound (inclusive) on record date, ISO 8601.

resultType
enum<string>
default:json

Result format. json (default) returns inline results; file returns a presigned S3 CSV URL (valid 1 hour) in place of the data array.

Available options:
json,
file
filePrefix
string

Customises the filename of the exported CSV when resultType=file.

transactionId
string

Filter by transaction ID. Comma-separated for multi-select.

currency
string

Filter by currency (ISO 4217). Comma-separated for multi-select.

paymentType
string

Filter by payment type, e.g. PAYIN, PAYOUT. Comma-separated for multi-select.

paymentSubType
string

Filter by payment sub-type (scheme), e.g. PI_SEPA_INST. Comma-separated for multi-select.

provider
string

Filter by provider. Comma-separated for multi-select.

providerExclude
string

Exclude transactions from the given providers. Comma-separated for multi-select.

endToEndRef
string

Filter by the provider's end-to-end reference. Comma-separated for multi-select.

reference
string

Filter by the customer-supplied reference. Comma-separated for multi-select.

uniqueReference
string

Filter by unique reference. Comma-separated for multi-select.

internalReference
string

Filter by internal reference. Comma-separated for multi-select.

payeeName
string

Filter by payee name. Comma-separated for multi-select.

payerName
string

Filter by payer name. Comma-separated for multi-select.

dateTime
string

Filter by exact transaction timestamp. Comma-separated for multi-select. For ranges use fromDate / toDate.

accountId
string

Filter by account ID (provider account IDs are also accepted). Comma-separated for multi-select.

paymentId
string

Filter by payment ID. Comma-separated for multi-select.

direction
string

Filter by transaction direction (e.g. IN, OUT). Comma-separated for multi-select.

isFee
enum<string>

When true, returns only fee transactions; when false, excludes them.

Available options:
true,
false
cardId
string

Filter by card ID. Comma-separated for multi-select.

merchantId
string

Filter by merchant ID. Comma-separated for multi-select.

merchantName
string

Filter by merchant name. Comma-separated for multi-select.

merchantCountry
string

Filter by merchant country. Comma-separated for multi-select.

reportFormat
string

Selects an alternate CSV column layout for resultType=file exports.

Response

Matching transactions, or a presigned export URL when resultType=file.

Inline JSON results, or — when resultType=file — a presigned CSV export URL.

success
boolean
Example:

true

data
object[]
total
integer

Total number of matching records across all pages.

Example:

42

page
integer

The 1-based page returned.

Example:

1

limit
integer

Page size used for this response.

Example:

10