v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Transactions

Get a list of transactions

Returns all transactions in an account with the ability to search, sort and filter. You need the "View Transactions" permission to use this endpoint. Additionally, you need either "Access to base transaction monitoring functionality" and/or "Access to base payment screening functionality" to use this endpoint.

get/v3/transactions

Query parameters

sortstring[]

Sorting criteria. Allowed fields: occurred_at, received_at (default), base_value.amount, base_value.currency, direction. Each criterion should be a string in the format: property_name for ascending order, or -property_name for descending order. For example, to sort by occurred date descending: -occurred_at. Multiple sort criteria are supported. Provide each as a separate 'sort' query parameter (e.g., ?sort=-occurred_at&sort=base_value.amount).

[
  "-direction"
]
searchstring

Search for a transaction using your transaction identifier. Partial Match.

customer.identifierstring uuid

Search for a full match using the identifier of the customer associated with the transaction.

identifierstring[]

Filter by specific transaction identifiers. Returns transactions matching any of the provided IDs (OR logic). Can be combined with other filters.

received_at_fromstring date-time

Filter by minimum received date/time (inclusive). ISO 8601 format.

received_at_tostring date-time

Filter by maximum received date/time (inclusive). ISO 8601 format.

occurred_at_fromstring date-time

Filter by minimum occurred date/time (inclusive). ISO 8601 format.

occurred_at_tostring date-time

Filter by maximum occurred date/time (inclusive). ISO 8601 format.

directionstring[]

Filter by transaction direction.

base_value.currencystring[]

Filter by currency code (ISO 4217).

base_value.amount_fromnumber double

Filter by minimum base amount (inclusive).

base_value.amount_tonumber double

Filter by maximum base amount (inclusive).

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

evaluation_outcomestring[]

Filter by transaction evaluation outcome.

typestring[]

Filter by transaction type.

review_decisionstring[]

Filter by transaction review decision.

Response

OK

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.