Detailed BOLETO Extract

Route to retrieve a detailed Boleto Receipt using it's end to end code or transaction code

Response Parameters

ParametersFormatDescription
returnbooleanResponse status ( true / false )
messageStringResponse message
dataObjectResponse data
codeStringTransaction code
e2eStringEnd to end from the transaction
transaction_typeStringTransaction type
code_transaction_typeStringCode transaction type
transaction_statusStringTransaction status
code_transaction_statusStringCode transaction status
amountStringTransaction amount
created_atStringCreated at
billet_dataObjectData boleto
digitable_lineStringline digitable boleto
issuerStringIssuer boleto
payee_documentStringPayee document boleto
payeeStringPayee name boleto
payer_documentStringPayer document boleto
payerStringPayer name boleto
end_hourStringEnd hour payer boleto
start_hourStringStart hour payer boleto
original_amountFloatOriginal value boleto
discount_amountFloatDiscounts amount boleto
interest_amountFloatInterest amount boleto
fine_amountFloatFine amount boleto
payment_amountFloatTotal amount boleto
payment_codeStringPayment code boleto
due_dateStringDue date boleto
external_codeStringExternal code boleto
settle_nextStringSettle next boleto
settle_dateStringSettle date boleto
receiptStringReceipt boleto

Transaction Type

valueDescription
1PIX
2TED
3DOC
4P2P
5BOLETO
6DEPOSIT BOLETO
7CARD
8REVERSAL
14TAX

Transaction Status Codes

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

Request Parameters

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