Skip to content

Generate a PDF or CSV statement

POST
/api/v1/banking/statements
curl --request POST \
--url https://core.example.com/api/v1/banking/statements \
--header 'Content-Type: application/json' \
--header 'session-token: <session-token>' \
--data '{ "bank_account_id": 1, "statement_range": "2026-04-15", "statement_range_to": "2026-04-15", "format_file": "pdf", "timezone": "UTC", "bank_card_id": 1, "outer_id": "example" }'

The banking client sends fields at the top level; Rails ParamsWrapper builds the statement object for the controller.

segregated_account_id
integer

ID of a business account accessible to the current user

Media typeapplication/json
object
bank_account_id
integer
statement_range
required
string format: date
statement_range_to
required
string format: date
format_file
string
default: pdf
Allowed values: pdf csv
timezone
required
string
default: UTC
bank_card_id
integer
outer_id
string

PDF or CSV

string format: binary

Authorization, validation, or business-rule error

Media typeapplication/json
object
success
required
boolean
status
required
integer
errors
required
One of:
Array<object>
object
code
string
kind
string
nullable
expiration
string
nullable
session
string
nullable
key
additional properties
any
key
additional properties
any
Example
{
"success": false,
"status": 403
}