get
https://api.staging.bancocdc.com.br/generated/detailed-boleto/
Route to retrieve detailed info about a boleto using its unique boleto code
Response parameters
| Parameters | Format | Description |
|---|---|---|
| return | Boolean | Response status (true/false) |
| message | String | Response message |
| data | Object | Object with boleto |
| code | String | Identification code |
| created_at | String | Created at |
| payment_date | String | Payment date boleto |
| clearing_date | String | Clearing date boleto |
| expired_date | String | Expired date boleto |
| code_transaction_type | Number | Transaction type code |
| transaction_type | String | Transaction type |
| code_transaction_status | Number | Transaction status code |
| transaction_status | String | Transaction status |
| digitable | String | Digitable boleto |
| bar_code | String | Bar code boleto |
| hash | String | Hash boleto |
| our_number | String | Our number boleto |
| messages | Object | Messages boleto |
| message1 | String | Message 1 boleto |
| message2 | String | Message 2 boleto |
| message3 | String | Message 3 boleto |
| message4 | String | Message 4 boleto |
| message5 | String | Message 5 boleto |
| amount | String | Amount boleto |
| interest | Object | Interest boleto |
| code_interest_type_tax | Number | Type tax interest code |
| interest_type_tax | String | Type tax interest |
| value | Number | Value interest |
| fine | Object | Fine Boleto |
| code_fine_type_tax | Number | Type tax fine code |
| fine_type_tax | String | Type tax fine |
| value | Number | Value fine |
| total_discounts | Number | Value discounts boleto |
| due_date | String | Due date boleto |
| inicial_hour | String | Inicial hour boleto |
| final_hour | String | Final hour boleto |
| receiver | Object | Receiver account boleto |
| document | String | Receiver account document boleto |
| name | String | Receiver account name boleto |
| account | String | Receiver account boleto |
| account_digit | String | Receiver account digit boleto |
| account_agency | String | Receiver account agency boleto |
| bank_code | String | Receiver account bank code Boleto |
| payer | Object | Payer account boleto |
| name | String | Payer account name boleto |
| document | String | Payer account document boleto |
Transaction Status Codes
| Code | Description |
|---|---|
| 1 | In Process |
| 2 | Approved |
| 3 | Canceled |
| 4 | Expired |
| 5 | Under Review |
| 6 | Pending |
| 7 | Sent For Refund |
| 8 | Refund Made |
| 9 | Paid |
| 10 | Created |
| 11 | Clearing |
| 12 | Consulted |
| 13 | Authorized |
| 14 | Paid via pix |
Type Tax
| Identification | Description |
|---|---|
| 1 | amount |
| 2 | percent |