Create a boleto payment

The boleto's digitable line (linha digitável — 47 digits for a bank boleto, 48 for a utility or tax bill) or its barcode (44 digits). Spaces, dots and hyphens are ignored by the check; the check digits must be right.

Amount to pay, in cents — a positive integer. Leave it out to pay the amount the boleto asks for today (txnUpdatedAmount, or its face value txnOriginalAmount when that is 0). When the boleto states no amount at all, send it here or with PUT .../boleto/{boletoId}. A boleto that accepts a range of amounts takes one between txnMinAmount and txnMaxAmount.

Balance category of the wallet to charge. FLEX_INTERNATIONAL is the general-purpose one. With it — and an amount the payment knows — you can confirm the payment or send it for approval without PUT .../boleto/{boletoId} first.

A note kept with the payment's details. It isn't sent to the beneficiary.

Day to pay, as YYYY-MM-DD (a date-time counts as its UTC day). Omit it, or send today — in timeZone — to pay as soon as the payment is confirmed. A later day makes the confirmation schedule the payment instead. A day before today is rejected. A bank boleto (type GENERIC) can only be scheduled for a business day: its due date — or the next business day, when that falls on a weekend or holiday — or, when it has no due date, any business day; a utility or tax bill (UTILITY_BILL), for any later day.

Time zone that decides what "today" is for scheduledAt. Only America/Sao_Paulo is supported: any other value, or none, is read as America/Sao_Paulo.

ID of the payment. Use it as {boletoId} in the payment endpoints.

Environment of the payment: LIVE (production) or TEST (sandbox).

ID of the realm.

ID of the organization.

ID of the organization's account.

ID of the wallet that pays.

The boleto's barcode (or digitable line), as the bank returned it.

Status of the payment:

• REQUESTED — created; its details can still be changed, and it can be sent for approval, confirmed or cancelled.
• PENDING_APPROVAL — waiting for the approvers the business policy names. It is paid once approved.
• EXPIRED — the approval deadline (approvalExpiresAt) passed while it was still waiting — also when it was approved but the policy's top-up of the wallet failed; the approval request (policyRequestId) tells which.
• SCHEDULED — confirmed for a later day. On scheduledAt, a new payment is created and paid; this one stays SCHEDULED.
• PAID — the bank accepted the payment; the money left the wallet.
• FAILED — the payment was refused, for the reason in failReason.
• CANCELLED — cancelled before it was paid.
• REFUNDED — paid, then reversed by the bank; the amount was returned.

Name of the beneficiary — who receives the money (beneficiário). Empty or null when the bank didn't say.

CPF or CNPJ of the beneficiary, digits only. Empty or null when the bank didn't say.

Name of who the boleto was issued to (pagador). Empty or null when the bank didn't say.

CPF or CNPJ of who the boleto was issued to, digits only. Empty or null when the bank didn't say.

Currency of the amounts, as an ISO 4217 numeric code: 986 (Brazilian real).

Face value of the boleto, in cents.

Discount the boleto granted on the day the payment was created, in cents (not refreshed later).

Late fine the boleto charged on the day the payment was created, in cents (not refreshed later).

Interest the boleto charged on the day the payment was created, in cents (not refreshed later).

Amount the boleto asked for when the payment was created, in cents — the face value with that day's discount, fine and interest applied. It isn't refreshed later: what will be paid is pendingConfirmation.amount, and what was paid, confirmedAmount.

Smallest amount the boleto accepts, in cents. 0 when it states none.

Largest amount the boleto accepts, in cents. 0 when it states none.

How the payment was made: INSTANT (when it was confirmed) or DELAYED (by a schedule, on its day).

Amount paid, in cents. 0 until the payment is made.

When the payment was created.

When the payment last changed.

Kind of boleto: GENERIC (a bank boleto) or UTILITY_BILL (a utility or tax bill — energy, water, phone, taxes). A bank boleto can only be scheduled for its due date (or the next business day), or for any business day when it has no due date. null or absent when the bank didn't say.

Bank that issued the boleto. null or absent when the bank didn't say.

Due date of the boleto (vencimento). null or absent when it has none — usual for utility and tax bills.

Last day the boleto can be paid (data limite de pagamento). null or absent when the bank didn't say.

Settlement date the bank reported for the boleto when it was looked up. null or absent when the bank didn't say.

Day the payment is scheduled for. Absent when it is paid as soon as it is confirmed.

Time zone scheduledAt was read in — always America/Sao_Paulo. Present only with scheduledAt.

ID of the schedule created when a payment for a later day was confirmed. Cancel the payment to cancel it.

ID of the approval request opened when the payment was sent for approval, or of the automatic approval that funded it. Absent otherwise.

Deadline for the approval: 21:00 (São Paulo time) of the day the payment is for, and at least one hour after it was sent for approval. Present once it was sent for approval.

When a confirmation first asked for the automatic approval of the matching business policy. Once set, every later confirmation of this payment follows that approval. Absent when no confirmation needed it.

While set and in the future, a confirmation is carrying out the matching policy's automatic approval, and cancelling the payment is refused until then.

When the payment was made. null or absent until then.

Balance category of the wallet the payment was charged to.

Why the payment failed, as an error code — for example LIMIT_EXCEEDED, INSUFFICIENT_FUNDS or REJECTED_BY_FRAUD. Only on FAILED payments.

When the payment was cancelled. null or absent unless it was.

When the bank reversed the payment.

Internal revision counter of the record.