Requisição para buscar dados de um boleto específico pelo nosso número do boleto

Dados da resposta

CampoTipoDescrição
identifierUUIDIdentificador do boleto
payerObjectDados do pagador do boleto
└── nameStringNome do pagador do boleto
└── documentNumberStringNúmero do documento do pagador do boleto
└── streetStringLogradouro do pagador do boleto
└── districtStringBairro do pagador do boleto
└── cityStringCidade do pagador do boleto
└── stateStringEstado do pagador do boleto
└── zipCodeStringCEP do pagador do boleto
issuerObjectDados do emissor do boleto
└── codeStringCódigo do banco emissor do boleto
└── nameStringNome do banco emissor do boleto
amountsObjectDados dos valores do boleto
└── interestNumberValor do juros diário do boleto em caso de atraso no pagamento
└── fineNumberValor da multa do boleto em caso de atraso no pagamento
└── daysToWriteOffNumberDias para baixa do boleto
└── daysToFineNumberDias para cobrança de juros do boleto
└── amountNumberValor final do boleto
└── originalAmountNumberValor original do boleto
datesObjectDados de datas do boleto
└── createDateDateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss )Data de criação do boleto
└── registerDateDateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss )Data de registro do boleto na CIP
└── paymentDateDateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss )Data de pagamento do boleto
└── clearingDateDateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss )Data de liquidação do boleto
└── writeOffDateDateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss )Data de baixa do boleto
└── cancellationDateDateTime (Formato UTC yyyy-MM-ddTHH:mm:SS.ssssss )Data de cancelamento do boleto
└── dueDateDate (Formato UTC yyyy-MM-dd )Data de vencimento do boleto
barCodeStringCódigo de barras do boleto
digitableLineStringLinha digitável do boleto
receiptMessageStringMensagem exibida no boleto
ourNumberStringNosso número do boleto
statusEnumStatus do boleto. (Verificar tabela de status)
emailsArray[String]Emails para o onde o boleto foi enviado

Descrição dos Status possíveis

StatusDescrição
OPENRegistro do boleto solicitado na instituição bancária
REGISTEREDBoleto registrado com sucesso na CIP
PAIDBoleto pago na rede bancária
SETTLEDBoleto liquidado
OVERDUEBoleto vencido, mas passível de pagamento
WRITE_OFFBoleto baixado por falta de pagamento
CANCELEDBoleto cancelado

Json da resposta:

{
    "identifier": "5d97db69-b5ef-41f8-bf12-67934e358de1",
    "payer": {
        "district": "Bairro Teste",
        "zipCode": "58000000",
        "city": "Cidade Teste",
        "street": "Rua Teste",
        "state": "PB",
        "name": "Pessoa Teste",
        "documentNumber": "40063670070"
    },
    "issuer": {
        "code": "218",
        "name": "BS2"
    },
    "amounts": {
        "interest": 0.0,
        "fine": 0.0,
        "daysToWriteOff": 90,
        "daysToFine": 0,
        "amount": 101.45,
        "originalAmount": 100.0
    },
    "dates": {
        "createDate": "2022-07-11T16:45:21.750049",
        "registerDate": "2022-07-11T16:45:31.828266",
        "paymentDate": null,
        "clearingDate": null,
        "writeOffDate": null,
        "cancellationDate": null,
        "dueDate": "2022-07-30"
    },
    "barCode": "21892906200000101450010003114724802980255138",
    "digitableLine": "21890010070311472480429802551381290620000010145",
    "receiptMessage": "Teste de emissão de boleto",
    "ourNumber": 330,
    "status": "OPEN",
    "emails": []
}

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!