All examples use fictitious data.
Request body
A boleto request is mainly composed of:- due date on August 17, 2026;
- 5% discount until August 16;
- 1.5% fine after the due date;
- 3% monthly interest after the due date.
Charge
The charge section defines what is being collected and how your system identifies the boleto.amount
Defines the boleto amount.
The value is sent in cents.
description
A short description of the charge.
external_id
An identifier generated by your own system.
Payer
Thecounterparty object identifies the person or company that will pay the boleto.
The information should correspond to the actual payer associated with the boleto.
Payment conditions
Thedue_detail object is where the main payment rules are configured.
Due date
due_detail.due_date
Defines the date on which the boleto becomes due.
Discounts
A discount is a benefit given to the customer for paying before the due date. Discounts are configured inside:Fixed discount before the due date
Usefixed_until_due when you want to define a specific discount for one or more dates before the due date.
Example:
Different discounts for different dates
You can define multiple discount dates:Discount per anticipated day
Theper_day_antecipated model calculates the discount based on how early the customer pays.
Example:
amountdefines the discount value;calculation_typedefines whether the value is an amount or percentage;calculation_daysdefines how days are counted.
working for working days or calendar for calendar days.
Discount calculation type
The discount can be calculated as:Percentage
Fixed amount
Fine
The fine is a penalty applied when the boleto is paid after the due date. It is configured with:Percentage fine
Fixed fine
Interest
Interest is another charge that can apply after the due date. It is configured with:Daily interest
Monthly interest
Exempt from interest
Bank-controlled interest
Fine vs. interest
Fine and interest are different concepts.Fine
A penalty for paying after the due date.Interest
A charge related to the period the payment remains overdue.Boleto expiration
expiration_date
Defines the boleto expiration date.
Receiving account
virtual_account_id
Identifies the virtual account associated with the boleto.
Boleto type
The request contains two fields that define the boleto configuration:invoice_type and wallet_type, open the Boleto Types guide.
There you can find:
- available
invoice_typevalues; - available
wallet_typevalues; - what each option represents;
- when each type should be used;
- examples of different boleto configurations.
Notes
notes
Optional additional information associated with the boleto.
Example:
Example: complete payment configuration
Suppose you want to create a boleto with:* Assuming the 5% discount applies on the payment date and no other charge applies.
Complete request example
For more information about the document and wallet configuration, see the Boleto Types guide.

