Retrieve Detailed generated boleto

Route to retrieve detailed info about a boleto using its unique boleto code

Response parameters

ParametersFormatDescription
returnBooleanResponse status (true/false)
messageStringResponse message
dataObjectObject with boleto
codeStringIdentification code
created_atStringCreated at
payment_dateStringPayment date boleto
clearing_dateStringClearing date boleto
expired_dateStringExpired date boleto
code_transaction_typeNumberTransaction type code
transaction_typeStringTransaction type
code_transaction_statusNumberTransaction status code
transaction_statusStringTransaction status
digitableStringDigitable boleto
bar_codeStringBar code boleto
hashStringHash boleto
our_numberStringOur number boleto
messagesObjectMessages boleto
message1StringMessage 1 boleto
message2StringMessage 2 boleto
message3StringMessage 3 boleto
message4StringMessage 4 boleto
message5StringMessage 5 boleto
amountStringAmount boleto
interestObjectInterest boleto
code_interest_type_taxNumberType tax interest code
interest_type_taxStringType tax interest
valueNumberValue interest
fineObjectFine Boleto
code_fine_type_taxNumberType tax fine code
fine_type_taxStringType tax fine
valueNumberValue fine
total_discountsNumberValue discounts boleto
due_dateStringDue date boleto
inicial_hourStringInicial hour boleto
final_hourStringFinal hour boleto
receiverObjectReceiver account boleto
documentStringReceiver account document boleto
nameStringReceiver account name boleto
accountStringReceiver account boleto
account_digitStringReceiver account digit boleto
account_agencyStringReceiver account agency boleto
bank_codeStringReceiver account bank code Boleto
payerObjectPayer account boleto
nameStringPayer account name boleto
documentStringPayer account document 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

Type Tax

IdentificationDescription
1amount
2percent

Request Parameters

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