Consultar o status de um boleto
POST
/api/CashIn/ConsultarBoleto
CashIn
Funcionalidade principal
A identificação do boleto a ser consultado é feita exclusivamente através do NossoNumero, que é o identificador único retornado pela API no momento da geração da cobrança. A resposta indicará o estado atual do boleto (ex: "Pendente", "Pago", "Baixado", "Vencido").
Casos de uso comuns
1.
2.
3.
Nota importante sobre automação: Visto que não há um sistema de notificação automática (Webhook) para a confirmação de pagamento de boletos, a automação do seu fluxo de negócio deve ser realizada através de consultas periódicas (polling) a este endpoint. Recomenda-se implementar uma rotina que consulte os boletos pendentes em intervalos de tempo definidos para verificar se o status foi alterado para "Pago".
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/CashIn/ConsultarBoleto' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"Data": {
"CodigoCanal": 0,
"CodigoCliente": 0,
"NossoNumero": "string"
}
}'Response Response Example
{
"Data": {
"Status": "string",
"Valor": 0,
"ValorPago": 0,
"ValorJuros": 0,
"ValorMulta": 0,
"DataGeracao": "string",
"DataVencimento": "string",
"DataPagamento": "string",
"OrigemBoleto": "string",
"NossoNumero": "string",
"LinhaDigitavel": "string",
"CodigoBarras": "string",
"IdentificadorCliente": "string",
"DadosPagador": {
"CpfCnpj": 0,
"Nome": "string",
"Endereco": "string",
"Bairro": "string",
"Cidade": "string",
"Cep": "string",
"Uf": "string",
"DdiTerceiro": 0,
"DddTerceiro": 0,
"NumeroCelularTerceiro": 0
}
},
"ResultCode": 0,
"Message": "string",
"ValidationData": {
"ResultCode": 0,
"Message": "string",
"Errors": [
{
"ErrorMessage": "string",
"FieldName": "string"
}
]
}
}Modificado em 2026-03-03 14:57:40