Skip to navigation

List issued boletos (Boleto Charge)

Paginated local mirror for this account. Every item includes updatedAt, the instant of the last successful synchronization with the settlement bank. This endpoint does not call the bank.

There is no historical backfill. The mirror contains charges issued after v2.85.0 and older charges hydrated by a successful detail lookup. Use GET .../charge/{chargeId} when you need the current authoritative result. Filters: barcode, payer, dueDate, status, page, pageSize (max 200). Requires boleto_charge.

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

statusstringOptional

Canonical status filter (OPEN, SETTLED, OVERDUE, WRITTEN_OFF, CANCELLED, EXPIRED).

dueDatedateOptional

Due date, YYYY-MM-DD.

payerstringOptional
Payer name or tax number.
barcodestringOptional
Barcode of the slip.
pageintegerOptional
Page number, starting at 1.
pageSizeintegerOptional<=200
Page size, up to 200.

Response

Page of boletos
itemslist of objectsOptional
pageintegerOptional
pageSizeintegerOptional
totalItemsintegerOptional
totalPagesintegerOptional
hasNextbooleanOptional

Errors

403
Forbidden Error