Skip to navigation

Retrieve account statement

Returns the account statement (transaction list). The response is always a list payload with items, totalElements, totalPages, page, size, hasNext, hasPrevious.

Exact lookups: endToEndId (PIX end-to-end ID) or identifier (integrator reference) queries the settlement bank for that PIX and returns a list with 0 or 1 item. When both are sent, identifier is tried first and endToEndId is used if it finds nothing. When either is set, pagination and filters are ignored. A transaction that does not exist returns 200 with items: [].

List with filters: omit both endToEndId and identifier to get a paginated list. Filtering is server-side only: use startDate/endDate, operation (PIX, TED, BOLETO, INTERNAL_TRANSFER, FEE) and order.

Page size is a maximum, not a guaranteed count. size / itemsPage is the ceiling for the page (max 100; a larger value is capped). items may contain fewer entries than requested (some rows are omitted after the settlement bank paginates). Advance with hasNext; do not assume len(items) == size. totalElements / totalPages follow the settlement bank’s pagination and may be approximate, especially with operation=FEE.

Ordering is by instant, with one-second resolution. The settlement bank does not guarantee a stable tie-break when several entries share the same second, and a new entry (or a refund stamped on the original instant) can shift later pages. Prefer order=asc, page until hasNext is false, and dedupe by endToEndId or partnerId. For real-time credits, subscribe to webhooks (pix.in.completed, pix.refund.received, transfer.internal.in) instead of polling. GET /v1/accounts/{accountId}/statement/advanced resumes by cursor.

PIX refunds. A refund line has reversal: true, partnerType: PIX_REFUND and originalEndToEnd (the PIX being refunded). operation stays PIX. The original PIX, once refunded, carries refundEndToEnd (the refund’s end-to-end), including a partial refund. A refund we initiated may repeat the original end-to-end in both endToEndId and originalEndToEnd.

Presentation only. description, party names and party documents can be rewritten (or a row omitted) for display. amount and the account balance never change. Operational credits from CorpX show as LANÇAMENTO DE CRÉDITO, not as a tariff refund. Real fees (fee-* / tarifario-fee-*) stay TARIFA / ESTORNO DE TARIFA. A debit to a fee account without those prefixes (CorpX fees before September 2026 and manual entries bcorpx-lanc-*) also shows as TARIFA. Commissions (tarifario-com*, or text containing “comissão”) show as LANÇAMENTO DE CRÉDITO on credit and TARIFA on debit, and stay an internal transfer. The fee-account party name is always TARIFA (never CorpX or the provider’s legal name). If presentation rules have never loaded, the call fails with 503 statement_rules_unavailable.

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.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Query parameters

endToEndIdstringOptional

PIX end-to-end ID. Returns a list with 0 or 1 item.

identifierstringOptional

Integrator reference (payment/QR identifier). Returns a list with 0 or 1 item; tried before endToEndId when both are sent.

pageintegerOptional>=0Defaults to 0

Zero-based page index. page=0 is the first page and page=1 is the second — they are different pages. Ignored when endToEndId or identifier is set.

sizeintegerOptional1-100

Page size (max 100). A larger value is capped at 100. This is a ceiling: items may have fewer entries than size. Ignored when endToEndId or identifier is set.

startDatedateOptional

Inclusive start date filter (list only).

endDatedateOptional

Inclusive end date filter (list only).

operationenumOptional

Filter by operation type (list only; server-side). Counts may be approximate.

Allowed values:
orderenumOptionalDefaults to desc

Sort by transaction instant (asc oldest first, desc newest first, default desc). Resolution is one second and there is no guaranteed tie-break when several entries share that second. Prefer asc and dedupe by endToEndId or partnerId.

Allowed values:

Response

Account statement retrieved.
accountIdstring
itemslist of objects

Page of statement rows. Length may be less than size.

tenantIdstringOptional
sourcestringOptional
startDatedateOptional
endDatedateOptional
pageintegerOptional

Zero-based page index.

sizeintegerOptional

Requested page size (ceiling). items may be shorter.

totalElementsintegerOptional

Total lines in the settlement-bank statement window. Approximate when rows are omitted after pagination.

totalPagesintegerOptional
hasNextbooleanOptional
fetchedAtdatetimeOptional

Errors

404
Not Found Error
409
Conflict Error
500
Internal Server Error