API BaaSAccounts

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** (mutually exclusive): use `endToEndId` to get 0 or 1 transaction by PIX end-to-end ID; use `identifier` to get all transactions with that integrator reference. When either is set, pagination and filters are ignored. **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. `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`.

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.

Query parameters

endToEndIdstringOptional

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

identifierstringOptional

Integrator reference (payment/QR identifier). Returns all transactions with this identifier. Mutually exclusive with endToEndId.

pageintegerOptional>=0Defaults to 0

Zero-based page index (0 = first page, 1 = second page, etc.). Ignored when endToEndId or identifier is set.

sizeintegerOptional1-500

Page size (max 500). 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 order by transaction date.
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