Preview boleto before payment
Queries boleto data by barcode or “linha digitável”. Returns beneficiary info,
amounts (original, interest, fine, discount, total), due date, and payment type.
Requires feature flag boleto_payment to be enabled for the tenant.
Pay with totalUpdated, not amount. amount is the face value encoded
in the barcode; totalUpdated is what the settlement bank accepts today
(face + interest + fine − discount). For an overdue slip they differ, the
settlement bank rejects any other value with boleto_amount_mismatch, and
totalUpdated changes every day — so query it on the day you pay.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Optional client-generated idempotency token (recommended for safe retries).
Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).
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.
Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.
Request
Barcode (47/48 digits) or linha digitável
Response
Face value in BRL — the amount encoded in the barcode. Do NOT use it to pay an overdue slip.
Amount to pay today (face + interest + fine − discount). Send this value in POST /boleto/pay. Recalculated daily on overdue slips.
Barcode (44 digits) as returned by the settlement bank
Linha digitável (47/48 digits)