Skip to navigation

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

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.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

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.

Request

This endpoint expects an object.
barcodestringRequired

Barcode (47/48 digits) or linha digitável

Response

Boleto preview data
typeenumOptional
Allowed values:
bankstringOptional
Issuing bank name
bankCodestringOptional
receiverNamestringOptional
receiverTaxIdstringOptional
payerNamestringOptional
payerTaxIdstringOptional
dueDatedateOptional
amountdoubleOptional

Face value in BRL — the amount encoded in the barcode. Do NOT use it to pay an overdue slip.

discountAmountdoubleOptional
interestAmountdoubleOptional
fineAmountdoubleOptional
totalUpdateddoubleOptional

Amount to pay today (face + interest + fine − discount). Send this value in POST /boleto/pay. Recalculated daily on overdue slips.

barcodestringOptional

Barcode (44 digits) as returned by the settlement bank

digitableLinestringOptional

Linha digitável (47/48 digits)

statusenumOptional
Allowed values:

Errors

400
Bad Request Error
403
Forbidden Error
502
Bad Gateway Error