Skip to main content
The Boletos page in Lerian Console lets you issue boletos and follow their lifecycle. It lists the form fields, the boleto states, and how to handle errors.

​
Accessing the Boletos page

To open the Boletos page, click Payments → Boletos from the left-side menu. The page displays boletos in a data table, with the following columns:
  • ID: the boleto identifier.
  • Type: the boleto type.
  • Amount: the boleto amount.
  • Due date: the date the boleto is due.
  • Status: the current lifecycle state (see States).
  • Created at: the date when you issued the boleto.
  • Actions: the cancel action, when the state allows it.
You can filter boletos by status, type, or due date range. Use the filter fields above the table. Click a row to open the boleto’s details page.

​
Issuing a boleto

1
From the Boletos page, click Issue new boleto. A side panel opens.
2
Fill in the fields:
  • Amount (required): the boleto value (R$).
  • Due date (required): the date the payer must pay the boleto. It cannot be in the past.
  • Ledger: the ledger selected in the Console header. You cannot change it in the panel.
  • Account (required): the Midaz account to associate with the boleto. Type its exact alias or full ID, then select it from the results.
  • Type (required): Traditional, the only type the service accepts.
  • CPF / CNPJ (required): the payer’s tax document.
  • Full name (required): the full name of the payer.
  • Street (required): payer’s street address.
  • Number (required): address number.
  • Complement (optional): apartment, suite, or additional address info.
  • Neighborhood (required): payer’s neighborhood.
  • City (required): payer’s city.
  • UF (required): payer’s state.
  • ZIP code (required): payer’s ZIP code.
  • Instructions (optional): payment instructions for the boleto.
3
Click Issue boleto.
4
The boleto’s details page opens. When the provider returns the digitable line and the barcode, the Payment data card shows them.
After you issue a boleto, share its digitable line with the payer.

​
Boleto states

A boleto moves through the following states:
  • Pending: the provider has not confirmed the boleto yet.
  • Created: the provider registered the boleto and the payer can pay it.
  • Settled: the payer paid the boleto.
  • Canceled: the boleto was canceled before payment.
  • Inactivated: the provider inactivated the boleto. The payer can no longer pay it.
  • Failed: the boleto issuance did not complete (see Error handling).

​
Canceling a boleto

You can cancel a boleto in the Created state. Click the cancel icon in the Actions column, or Cancel boleto on the details page. Enter a Reason and click Cancel boleto to confirm.

​
Error handling

The form checks each field before it sends the request. If the service refuses the request, an error message appears. A boleto whose issuance did not complete shows the Failed state. Its details page shows the Failure details in the Status history. If a send gets no answer, the panel shows a warning. Check the Boletos list before you send the form again. If you changed the form or the header ledger after that send, Issue boleto is disabled. To issue the boleto as a new one, click Send as new, confirm, then click Issue boleto. If the last send went through, the new send can issue a second boleto.
To issue boletos, you need the appropriate Payments permissions. If you cannot see the Issue new boleto button, ask your administrator to check your role permissions.

Payments introduction

Bill Payments