Skip to navigation

Create statement export (async)

Queues an asynchronous export of the account statement for the given date range (format: csv, pdf, xlsx, or ofx). Poll GET /v1/accounts/{accountId}/exports until status is COMPLETED, then download via GET /v1/accounts/{accountId}/exports/{exportId}/download. The file contains live statement rows from the banking partner (ISPB 50871921). Columns match the statement, plus ispb. The last column is pixKey — the same field as on each statement item (incoming key on a credit; destination key on a debit). Empty outside PIX and on older rows. Saldo após transação (balance) is not included. CSV and XLSX use the requested date range in full (no row cap). PDF clamps dates to 21/05/2026 … today (an end date in the future becomes today) and does not truncate at 10,000 rows. XLSX continues on extra sheets (Statement_2, …) if a single Excel sheet fills. The PDF is A4 landscape, in Portuguese (type, direction and status labels, never raw enums), and carries the tenant’s brand: the PNG logo from the tenant branding or, without one, the tenant’s name. CorpX appears only in the footer. Long cells wrap instead of being cut, so the end-to-end ID and the counterparty name come out whole; the counterparty CPF/CNPJ is shown in full. There is no balance column. ofx (OFX 1.0.2, for accounting and ERP reconciliation) lists the same live rows in ascending order: credit positive, debit negative, FITID from the transaction ID, BANKID 681, and LEDGERBAL with the account balance at the moment the file is generated. ofx is only accepted with type=statement.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
typeenumRequired

Export type. Only statement is supported.

Allowed values:
startDatedateRequired

Inclusive start date (YYYY-MM-DD).

endDatedateRequired

Inclusive end date (YYYY-MM-DD).

formatenumOptionalDefaults to csv

File format. csv and xlsx share the same columns. pdf is a formatted statement (dates clamped to 21/05/2026 … today). ofx is OFX 1.0.2 for accounting reconciliation.

Allowed values:
hideEndToEndbooleanOptionalDefaults to false

When true, the statement file omits the end-to-end id. In csv and xlsx the “ID fim a fim” column stays in place but is empty, so column positions do not move. In pdf the id column is titled “Identificador” and shows only the identifier. In ofx the id is removed from REFNUM, MEMO and FITID. Applies to statement exports only; ignored for other types. Defaults to false.

Response

Export job accepted.
exportIdstring
accountIdstring
tenantIdstring
typestring
statusenum
Allowed values:
createdAtdatetime
formatenumOptional
Allowed values:
paramsmap from strings to anyOptional

The request echoed back, including hideEndToEnd when it was set.

rowCountintegerOptional
errorReasonstringOptional
completedAtdatetimeOptional

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error