Issue a boleto (Boleto Charge)
Issues a boleto for this account. Scope boleto_charge.manage. The feature boleto_charge starts disabled for every tenant, including tenants created after this release. While it is off every boleto charge route returns 403 feature_disabled. With the feature on, issuance still requires boletoCharge.enabled=true on the tenant policy (every account of the tenant) or on this account’s policy; otherwise the route returns 403 boleto_charge_account_disabled. enabled=false on the account policy opts that account out of a tenant-wide enable.
Beneficiary. If the holder is not yet a beneficiary (or the relationship is closed), this call registers the holder from the account’s own data and returns 202 with errorCode: boleto_charge_beneficiary_pending and Retry-After: 300. Nothing was issued. Repeat the same body in a few minutes. You can also register first with POST .../boleto/charge/beneficiary (no body).
identifier is required in the JSON body and is the only idempotency key for this operation. Idempotency-Key is not accepted as a fallback. Repeating the same boleto returns 200 without consuming quota again.
The beneficiary is validated before quota is reserved. A new issuance
must fit both monthly BRT quotas: the tenant policy
boletoCharge.maxIssuesPerMonth (default 100) and the account policy
(default 5 for PF, 10 for PJ). Once admitted, the slot is consumed even
if the settlement bank later fails; it is never refunded.
When the beneficiary is already eligible and quota is available, the response is 202 with the boleto (chargeId, barcode, digitableLine). Registration at the central base is still asynchronous: subscribe to boleto.charge.registered and boleto.charge.registration_failed.
There is no write-off of an open boleto. Bound validity with expirationPolicy.paymentLimitDate.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Request
Caller-owned idempotency key, unique per account.
Due date, YYYY-MM-DD.
Issue date, YYYY-MM-DD. dueDate cannot be before it.
Early-payment discount. Each groups[].limitDate must be before dueDate.
How long the boleto can be paid. There is no write-off of an open boleto; paymentLimitDate is how you bound validity.
Response
Settlement-bank id of this boleto. Use it on the item route and in webhooks.
Linha digitável.