Skip to main content
POST
Create a statement for a date range

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128
Idempotency-Key
string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

Path Parameters

account_id
string
required

Account.

Pattern: ^acc_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

"Create statement" for a custom range. Both PDF and CSV are produced.

period_start
string<date>
required

"From".

Example:

"2026-11-07"

period_end
string<date>
required

"To" (inclusive). Not in the future; at most 12 months after period_start.

Example:

"2026-11-07"

Response

Accepted.

An account statement (AccountStatements). Generated asynchronously.

id
string
required

Statement id.

Pattern: ^stm_[0-9A-HJKMNP-TV-Z]{26}$
object
string
required

Always statement.

Allowed value: "statement"
created_at
string<date-time>
required

When it was created.

Example:

"2026-10-27T08:41:00Z"

updated_at
string<date-time>
required

When it was created.

Example:

"2026-10-27T08:41:00Z"

account_id
string
required

Account.

Pattern: ^acc_[0-9A-HJKMNP-TV-Z]{26}$
kind
enum<string>
required

Monthly statements are made automatically on the 1st; custom ones on request ("Custom range").

Available options:
monthly,
custom
period_start
string<date>
required

First day covered.

Example:

"2026-11-07"

period_end
string<date>
required

Last day covered (inclusive).

Example:

"2026-11-07"

status
enum<string>
required

scheduled: the month is not over ("Ready on 1 November"). processing: being made ("In progress"). ready: downloadable.

Available options:
scheduled,
processing,
ready,
failed
transaction_count
integer | null
required

"41 transactions". Null until ready.

Required range: x >= 0
formats
enum<string>[]
required

Formats available to download.

File format.

Available options:
pdf,
csv
requested_by
object
required

Who asked for it (system for monthly ones).

available_on
string<date> | null

For scheduled: the date it will be ready.

opening_balance
object | null

Ledger balance at the start. Null until ready.

closing_balance
object | null

Ledger balance at the end. Null until ready.

completed_at
string<date-time> | null

When it became ready.