Retrieve generated boleto

Route to retrieve a list of generated boletos based on the filters passed

📘

The transaction_status filter alters some rules

When initial_date and final_date are provided, results are filtered by created_at by default.

However, if a transaction_status filter is also supplied, the date field used for filtering may change. For paid(2) transaction statuses, the date filter is applied to payment_date instead of created_at.

Response parameters

ParametersFormatDescription
returnBooleanResponse status (true/false)
messageStringResponse message
pageNumberPage on this request
total_pagesNumbertotal pages
registriesNumberregistries on this request
total_registriesNumbertotal registries
dataArray of objectObject with boletos
codeStringIdentification code
created_atStringCreated at
due_dateStringDue date
code_transaction_typeNumberTransaction type code
transaction_typeStringTransaction type
code_transaction_statusNumberTransaction status code
transaction_statusStringTransaction status
receiver_accountStringReceiver account
digitableStringDigitable boleto
amountStringAmount boleto

Transaction Status Codes

CodeDescription
1In Process
2Approved
3Canceled
4Expired
5Under Review
6Pending
7Sent For Refund
8Refund Made
9Paid
10Created
11Clearing
12Consulted
13Authorized
14Paid via pix

Request Parameters

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!