Search transactions

get

https://api.uat.paymentology.com/pty/account/v1/transactions

Search for transactions across all types (card payments, transfers, deposits, withdrawals, fees, adjustments and interest).
Exactly one of account_id or token must be provided as a query parameter.
Returns a paginated list sorted by updated_at descending (newest first) by default.
The maximum allowed date range between updated_from and updated_to is 1 year.

Query Params

account_id

string

length between 1 and 50

Account identifier. Exactly one of account_id or token must be provided.

token

string

length between 1 and 50

Token identifier. Exactly one of account_id or token must be provided.

type

array of objects

Filter by transaction type(s). Multiple values comma-separated.

type

transaction_reference

string

length ≤ 100

Exact match on transaction_reference

transaction_description

string

length ≤ 255

Partial match on transaction_description

currency

string

^[A-Z]{3}$

Filter by currency (ISO 4217)

min_amount

string

^[0-9]+$

Minimum amount in minor units (inclusive)

max_amount

string

^[0-9]+$

Maximum amount in minor units (inclusive)

updated_from

date-time

Return transactions created at or after this time (inclusive). Transactions are immutable once posted, so this is their creation time. Any timezone offset is accepted. The range may not exceed 366 days; when only one bound is given, the range is measured against the current time.

updated_to

date-time

Return transactions created before this time (exclusive). Transactions are immutable once posted, so this is their creation time. Any timezone offset is accepted. The range may not exceed 366 days; when only one bound is given, the range is measured against the current time.

merchant

string

length ≤ 100

Partial match on merchant name (card transactions only)

sort_by

string

enum

Defaults to UPDATED_AT

Field to sort results by AMOUNT requires currency.

Allowed:

sort_order

string

enum

Defaults to DESC

Sort direction

Allowed:

limit

int32

1 to 100

Defaults to 20

Maximum number of results to return (default 20, max 100)

cursor

string

Opaque pagination cursor from the previous response's next_cursor. Send it with exactly the same filters and sort as the request that returned it.

Responses

403

Access token rejected by the API gateway (for example, expired).

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400BAD_REQUEST: invalid parameter. Examples: neither or both of account_id and token provided; updated_from not before updated_to; date range over 366 days; min_amount greater than max_amount; sort_by=AMOUNT without currency.

401Missing or invalid access token: UNAUTHORIZED, INVALID_CLIENT or INVALID_TENANT.

404NOT_FOUND: account_id does not exist or does not belong to the client. An unknown token returns an empty result instead.

500INTERNAL_SERVER_ERROR: unexpected error, including a search that takes longer than 10 seconds. Narrow the filters and retry.

503INFRASTRUCTURE_ERROR: temporary failure, retry later.