Create a Transactions Request

Creates an asynchronous request to retrieve transactions for an account over a date range.

The request is processed asynchronously: a 202 response returns the request id (use this value as {request_id} when polling) and an initial status of pending. Poll for the result using the returned id.

Results are paginated and returned in a stable order: by timestamp descending, then id descending as a unique tie-breaker. Pass the next_cursor from a previous page as cursor to retrieve the next page; a null next_cursor means there are no further transactions.

This API must be called using a client_credentials bearer token.

Note: from/to applies to settled transactions. Returned pending transactions may have dates outside the requested range — behaviour varies by bank.

Path Params
string
required

The unique identifier of the account.

Body Params
date
required

The start of the date range (inclusive) for which to retrieve transactions, in YYYY-MM-DD format.

date
required

The end of the date range (inclusive) for which to retrieve transactions, in YYYY-MM-DD format.

string

Cursor used for pagination. Pass the next_cursor value from a previous response to retrieve the next page of results.

integer
1 to 500
Defaults to 50

The maximum number of transactions to return per page. Optional; if omitted, defaults to 50.
The server returns min(500, requested) items.

enrichment
object

Optional. When provided, requests that enrichment be performed on the retrieved transactions.

Headers
string
required

The unique identifier of the data connection.

string

Used to collect and record the end-user's IP address.
The first IP address in the list will be used as the end-user IP address.
Necessary to overcome 4 calls per day rate limits.

string
enum
Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json; charset=UTF-8
application/problem+json; charset=UTF-8