Skip to main content
POST
Create a statement request
Create a new statement request. The statement will be generated asynchronously and made available via the delivery channel specified by send_via. Use Get Statement Details to poll for completion and retrieve a download URL. Supports accounts, trades, and incoming_funds statement types. Valid statement_type / format combinations:
  • accounts: csv, pdf, xls, coda
  • trades: pdf, xls
  • incoming_funds: csv, pdf, xls
The currencies field is only valid when statement_type is accounts.

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

Query Parameters

client_id
string
required

The ID of the client

Body

application/json

Statement creation parameters

statement_type
enum<string>
required

The type of statement to create.

Available options:
accounts,
trades,
incoming_funds
date_from
string<date>
required

Start date for the statement (YYYY-MM-DD)

Example:

"2020-01-01"

date_to
string<date>
required

End date for the statement (YYYY-MM-DD)

Example:

"2020-01-31"

format
enum<string>
required

The file format of the statement. Allowed values depend on statement_type — see the endpoint description for valid combinations.

Available options:
csv,
pdf,
xls,
coda
currencies
string

Comma-separated list of currency codes (ISO 4217). Only valid when statement_type is accounts.

Pattern: ^([A-Z]{3},?)+$
Example:

"EUR,GBP,USD"

send_via
enum<string>

How the generated statement should be delivered

Available options:
push,
email,
both

Response

Statement request accepted

Statement request details with download URL for completed statements

uuid
string
required

Unique identifier for the statement request

Example:

"86f62d50-baa2-38dd-f61c-0eacc34ead50"

statement_type
enum<string>
required

Type of statement

Available options:
accounts,
trades,
mt940,
incoming_funds
Example:

"accounts"

file_format
enum<string>
required

Format of the statement file

Available options:
pdf,
csv,
xls,
mt940,
coda
Example:

"pdf"

status
integer
required

Status code (0=Pending, 1=Running, 2=Completed, 3=Failed)

Example:

2

status_display
string
required

Human-readable status

Example:

"Completed"

start_datetime
string<date-time>
required

Start date/time for the statement period

Example:

"2026-01-01T00:00:00"

end_datetime
string<date-time>
required

End date/time for the statement period

Example:

"2026-03-31T23:59:59.999999"

created_at
string<date-time>
required

When the request was created

Example:

"2026-04-07T21:18:49.061735"

completed_at
string<date-time> | null

When the statement was completed (null if not yet complete)

Example:

"2026-04-07T21:19:00.123456"

file_name
string | null

Name of the generated file (null if not yet complete)

Example:

"statement_2026-01-01_2026-03-31.pdf"

download_url
string | null

Pre-signed S3 URL for downloading the statement (null if not yet complete, expires after 15 minutes)

Example:

"https://s3.amazonaws.com/bucket/file.pdf?X-Amz-Signature=abc123"

error_message
string | null

Error message if the request failed

Example:

null