List issued boletos (Boleto Charge)

Live list at the settlement bank for this account holder. Not a local mirror. Filters are the ones the bank accepts: 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.
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

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