v1

latestOpenAPI 3.0.32026-07-132044132.5 KB
Transactions

List transactions by account

Retrieve a list of all transactions for a specific account. The returned list is paginated and can be scrolled by following the next and prev links where present. To narrow the results to a specific date range pass one or both of filter[since] and filter[until] in the query string. These filter parameters should not be used for pagination. Results are ordered newest first to oldest last.

get/accounts/{accountId}/transactions

Path parameters

accountIdstring required

The unique identifier for the account.

Query parameters

page[size]integer

The number of records to return in each page.

filter[status]'HELD' | 'SETTLED'

Specifies which stage of processing a transaction is currently at. Currently returned values are HELD and SETTLED. When a transaction is held, its account’s availableBalance is affected. When a transaction is settled, its account’s currentBalance is affected.

The transaction status for which to return records. This can be used to filter HELD transactions from those that are SETTLED.

filter[since]string date-time

The start date-time from which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.

filter[until]string date-time

The end date-time up to which to return records, formatted according to rfc-3339. Not to be used for pagination purposes.

filter[category]string

The category identifier for which to filter transactions. Both parent and child categories can be filtered through this parameter. Providing an invalid category identifier results in a 404 response.

filter[tag]string

A transaction tag to filter for which to return records. If the tag does not exist, zero records are returned and a success response is given.

Response

Successful Response