| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Descrição
Esse endpoint permite a consulta de um boleto hibrido previamente criado, sendo possível consultar boletos em diferentes estágios de analise e baixa.
Corpo de Response
| Campo | Tipo | Descrição |
|---|---|---|
identifier | UUID | identificador do boleto hibrido |
accountIdentifier | UUID | _identificador da conta |
dueDate | LocalDate | Data de vencimento do boleto |
expirationDaysAfterDueDate | Int | Quantidade em dias para expiração do boleto |
urlNotification | String | Url para notificação |
yourNumber | Long | Seu número informado na requisição de emissão |
emails | Array | Emails para envio do boleto emitido |
barCode | LocalDate | Data de vencimento do boleto |
digitableLine | String | Linha digitável do boleto |
copyAndPaste | String | Cópia do boleto |
endDate | LocalDate | Data final do boleto |
payer | Object | Dados do pagador |
└── name | String | Nome do pagador |
└──documentNumber | String | Numero do documento do pagador |
└── tradingName | String | Nome fantasia |
└── street | String | Rua do pagador |
└── district | String | Distrito do pagador |
└── city | String | Cidade do pagador |
└── state | String | Estado do pagador (Obrigatório inserir apenas UF, exemplo: SP) |
└── zipCode | String | CEP do pagador |
└── email | String | Email do pagador |
additionalInformation | Array | Informações adicionais do boleto |
value | BigDecimal | Valor associado ao boleto |
discounts | Array | Descontos do boleto/ QrCode |
interestType | Enum | Tipo de juros do boleto / QrCode |
interestValue | BigDecimal | Porcentagem de juros do boleto |
fineType | Enum | Tipo de multa do boleto / QrCode |
fineValue | BigDecimal | Porcentagem de multa do boleto/ QrCode |
description | String | Descrição do boleto/QrCode |
keyValue | String | Valor da chave Pix |
status | Int | Dias para baixa automática dos boletos após o vencimento |
settlementAmount | int | Valor liquidado do boleto hibrido |
settlementDate | LocalDateTime | Data da liquidação |
paymentDate | LocalDateTime | Data de pagamento do boleto hibrido |
paymentOrigin | Enum | Origem do pagamento do boleto hibrido |
Valores possíveis para InterestType
| Status | Descrição |
|---|---|
VALUE_PER_DAY | Valor (dias corridos) |
PERCENTAGE_PER_DAY | Porcentagem ao dia |
Valores possíveis para fineType
| Status | Descrição |
|---|---|
FIXED_VALUE | Valor fixo |
PERCENTAGE | Percentual |
Valores possíveis para o Status do boleto hibrido
| Status | Descrição |
|---|---|
PENDING | Indica pendencia do mesmo |
ISSUED | Indica que o mesmo esta emitido |
SETTLED | Indica que o mesmo foi liquidado |
PAID | Indica que o mesmo foi pago |
OVERDUE | Boleto vencido. Passível de pagamento |
CANCELLED | Indica que o mesmo foi cancelado |
Valores possíveis para paymentOrigin
| Status | Descrição |
|---|---|
PIX | Pagamento realizado por pix |
BILL | Pagamento realizado por boleto |
Json do response
{
"identifier": "3ffaf463-e8d3-4ffe-a746-5a025d77ee19",
"accountIdentifier": "2d79fee8-ff55-45bc-b9d8-fcaae5f736b1",
"dueDate": "2026-04-08",
"expirationDaysAfterDueDate": 0,
"urlNotification": "urlNotification_0fd899be59ed",
"yourNumber": 0,
"emails": [
"emails_69e21e8069ae"
],
"barCode": "barCode_180387b76f7d",
"digitableLine": "digitableLine_5bd246057504",
"copyAndPaste": "copyAndPaste_eabfde270d15",
"payer": {
"name": "name_215fbfb9f38e",
"documentNumber": "documentNumber_221fc2e11170",
"tradingName": "tradingName_6393548f091a",
"street": "street_0e0f40b9afd5",
"district": "district_26ff71ace734",
"city": "city_ba03cf26b655",
"state": "AC",
"zipCode": "zipCode_f9cfdb68c8e9",
"email": "email_62db15740f7e"
},
"additionalInformation": [
{
"identifier": "f3a5d2ca-e6b0-4055-b92c-bda322c84fa2",
"name": "name_29355bab8676",
"value": "value_168e8834af8e"
}
],
"value": 0.00,
"discounts": [
{
"identifier": "651d7e6b-7c76-458e-9c0f-5d0da024ebb6",
"date": "2026-04-08",
"value": 0.00
}
],
"interestType": "PERCENTAGE_PER_DAY",
"interestValue": 0.00,
"fineType": "FIXED_VALUE",
"fineValue": 0.00,
"description": "description_dd2ebf116985",
"keyValue": "keyValue_f5f7f7d73845",
"status": "PENDING",
"endDate": "2026-04-08",
"settledAmount": 0.00,
"settlementDate": "2026-04-08 09:02:32",
"paymentDate": "2026-04-08 09:02:32",
"paymentOrigin": "PIX"
}