Skip to main content
POST
Create statement file for an account
Generate a statement asynchronously in PDF, CSV or MT940 format for a given account. It is not possible to generate statements for periods longer than 31 days. In order to retrieve the generated statement go to Retrieve a statement for an account
Technical note: the input dates (and output file names) will be understood as of Europe/London timezone. This timezone can be GMT/WET (UTC+00:00), or BST/WEST (UTC+01:00) when DST is applied. This occasional shift from UTC, during DST, prevents us to label these dates as being UTC. If you are not sure if this warning applies to your scenario, ignore it.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

X-Contact-ID
string

The ID of the contact

Path Parameters

account_id
string
required

Account UUID

Query Parameters

client_id
string
required

The ID of the client

format
string
default:pdf

The format of the statement to generate

Body

application/json

Request Payload

from_value_datetime
string
required

Only return transactions with value date after this date. Time ignored, considered always to be the start of the day. YYYY-MM-DDThh:mm format

to_value_datetime
string

Only return transactions with value date before this date. Time ignored, considered always to be the end of the day. YYYY-MM-DDThh:mm format

Response

Statement processing started

url
string
required

The url needed to retrieve the statement. It contains two UUID values, the first one (from the left) is the account id and the second one is the statement id.