Preview boleto before payment

POST

https://tenant.api.corpx.com/v1/accounts/:accountId/boleto/preview

POST

/v1/accounts/:accountId/boleto/preview

curl -X POST https://tenant.api.corpx.com/v1/accounts/accountId/boleto/preview \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "barcode": "23793.38128 60000.000003 00000.000408 1 84340000012345"
}'

{
  "type": "boleto-payment",
  "bank": "Itaú Unibanco S.A.",
  "bankCode": "341",
  "receiverName": "MARIA DA SILVA",
  "receiverTaxId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "payerName": "MARIA DA SILVA",
  "payerTaxId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "dueDate": "2026-02-20",
  "amount": 1430.63,
  "discountAmount": 150.75,
  "interestAmount": 3.29,
  "fineAmount": 28.61,
  "totalUpdated": 1462.53,
  "barcode": "23793381286000782713695000063305975520000015075",
  "digitableLine": "23793381286000782713695000063305975520000015075",
  "status": "PAYABLE"
}

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.

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.

Request

This endpoint expects an object.

barcodestringRequired

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

Response

Boleto preview data

typeenumOptional

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

Errors

400

Bad Request Error

403

Forbidden Error

502

Bad Gateway Error

Authentication

Path parameters

Headers

Request

Response

Errors