Statements Models

These models are used by the create and get statements endpoints.

StatementSupportedTypes

This is an enumeration of the supported formats for a statement Values

Value	Description
`pdf`	Generate a single statement in pdf format.
`csv`	Generate a single statement in csv format.
`mt940`	Generate multiple statements, one for each day in the period, in mt940 format. The result will be a zip file with all the mt940 statements.

StatementFileStatus

  {
    "status": "Pending"
  }

This model is a representation of the current status of statement. Fields

string

The StatementStatus for the statement.

StatementStatus

This is an enumeration of possible status in which a statement can be. Values

Value	Description
`Pending`	The statement has not been processed yet.
`Failed`	The statement processing failed.

Email Accounts Statements

POST /statements/accounts HTTP/1.1
Authorization: string
Content-Type: application/json

{
    "client_id": "string",
    "date_from": "string",
    "date_to": "string",
    "format": "string",
    "currencies": "string"
}

Send accounts statements via email to a specified contact. The statement will include transactions for the specified period and currencies.

See here for details of required headers.

Request Body

Query Parameters

string

required

The ID of the client.

Body

string

required

Start date for the statement period. YYYY-MM-DD format. The date range between date_from and date_to must not exceed 3 years.

string

required

End date for the statement period. YYYY-MM-DD format. The date range between date_from and date_to must not exceed 3 years.

string

The format of the statement. Valid values: csv, pdf, xls, coda. Default is pdf.

string

Comma-separated list of currency codes to include in the statement (e.g., “GBP” or “GBP,EUR,USD”). If omitted, all currencies will be included.

string

How the generated statement should be delivered. Valid values: push, email, both.

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "Request accepted, you will receive an email with the statement."
}

A successful request will send the statement to the specified contact’s email address.

See here for details of unsuccessful requests.

Email Trade Statements

POST /statements/trades HTTP/1.1
Authorization: string
Content-Type: application/json

{
    "date": "string",
    "format": "string"
}

Send a trade statement via email to a specified client.

See here for details of required headers.

Request Body

Query Parameters

string

required

The ID of the client

Body

string

required

The date or period for the trade statement. YYYY-MM-DD or YYYY-MM formats.

string

The format of the statement. Valid values: pdf, xls. Default is pdf.

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "Request accepted, you will receive an email with the statement."
}

A successful request will send the trade statement to the specified contact’s email address.

See here for details of unsuccessful requests.

Email MT940 Statements

POST /statements/mt940 HTTP/1.1
Authorization: token <your_token>
Content-Type: application/json

{
    "date_from": "string",
    "date_to": "string",
    "account_ids": [2924, 2925],
    "subtags": false
}

Send MT940 format statements via email to a specified contact.

See here for details of required headers.

Request Body

Query Parameters

string

required

The ID of the client

Body

string

required

Start date for the statement period. YYYY-MM-DD format. The date range between date_from and date_to must not exceed 3 years.

string

End date for the statement period. If not provided, defaults to the value of date_from. YYYY-MM-DD format. The date range between date_from and date_to must not exceed 3 years.

array

Array of account IDs to include in the statement (e.g., [2924, 2925]). If not provided, all accounts will be included.

boolean

Boolean flag to enable/disable subtags in the MT940 output. Default is false.

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "Request accepted, you will receive an email with the statement."
}

A successful request will send the MT940 statement to the specified contact’s email address.

See here for details of unsuccessful requests.

Email Incoming Funds Statements

POST /statements/incoming-funds HTTP/1.1
Authorization: string
Content-Type: application/json

{
    "format": "string",
    "date_from": "string",
    "date_to": "string"
}

Send an incoming funds statement via email to a specified client.

See here for details of required headers.

Request Body

Query Parameters

string

required

The ID of the client

Body

string

The format of the statement. Valid values: csv, xls, pdf. Default is csv.

string

required

Start date for the statement period. YYYY-MM-DD format. The date range between date_from and date_to must not exceed 3 years.

string

required

End date for the statement period. YYYY-MM-DD format. The date range between date_from and date_to must not exceed 3 years.

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "Request accepted, you will receive an email with the statement."
}

A successful request will send the incoming funds statement to the specified contact’s email address.

See here for details of unsuccessful requests.

​StatementSupportedTypes

​StatementFileStatus

​StatementStatus

​Email Accounts Statements

​Request Body

​Response

​Email Trade Statements

​Request Body

​Response

​Email MT940 Statements

​Request Body

​Response

​Email Incoming Funds Statements

​Request Body

​Response

StatementSupportedTypes

StatementFileStatus

StatementStatus

Email Accounts Statements

Request Body

Response

Email Trade Statements

Request Body

Response

Email MT940 Statements

Request Body

Response

Email Incoming Funds Statements

Request Body

Response