Validar linha digitável de boleto (CIP)

POST

/api/CashOut/ConsultarBoletoPagamentoOnline

CashOut

Funcionalidade principal

O ConsultarBoletoPagamentoOnline realiza a decodificação da linha digitável ou código de barras e retorna os detalhes do beneficiário, data de vencimento e o valor (incluindo cálculos automáticos de juros ou descontos, se aplicável). É o passo indispensável para garantir que o usuário não pague um boleto vencido ou com dados incorretos.

Casos de uso comuns

Checkout de pagamento: Quando o usuário cola um código de barras no App, o sistema chama este endpoint para exibir: "Você está pagando à Empresa X o valor de R$ Y".

Validação de fraude: Verificar se o beneficiário que consta no registro do boleto coincide com o esperado, prevenindo golpes de boletos falsos.

Cálculo de encargos: Obter o valor final a ser pago em um boleto que já venceu, onde o sistema de registro calcula juros e multas em tempo real.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/CashOut/ConsultarBoletoPagamentoOnline' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "LinhaDigitavel": "string",
        "TipoPagamento": 0
    }
}'

Response Example

{
    "Data": {
        "RetornoXMLBase64": "string",
        "RetornoConsultaBoletoPagamentoOnline": {
            "CpfCnpjBeneficiario": "string",
            "NomeFantasiaBeneficiario": "string",
            "RazaoSocialBeneficiario": "string",
            "TipoPessoaBeneficiario": "string",
            "CodigoBarras": "string",
            "LinhaDigitavel": "string",
            "DataVencimento": "string",
            "ValorTotal": "string",
            "ValorDesconto": 0,
            "ValorCalculado": 0,
            "ValorEncargos": 0,
            "ValorJuros": 0,
            "ValorMulta": 0,
            "NomePagador": "string",
            "CpfCnpjPagador": "string",
            "TipoPessoaPagador": "string",
            "CodigoInstituicaoEmissora": "string",
            "NomeInstituicaoEmissora": "string",
            "PagamentoParcial": true,
            "ValorPagamentoMinimo": 0,
            "ValorPagamentoMaximo": 0,
            "DadosArrecadacao": {
                "NomeEmpresa": "string",
                "CodigoSegmento": "string",
                "DescricaoSegmento": "string",
                "AceitaPagamentoDivergente": true,
                "AceitaPagamentoAposVencimento": true
            }
        },
        "PermissaoConsultaBoletoOnline": "PERMITIDO_CONSULTA_ONLINE",
        "CanalCorban": {
            "TipoPagto": "string",
            "Corban": "string"
        }
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:26:25

Página anterior

Autorizar TED pré-cadastrada

Próxima página

Liquidar boleto ou conta de consumo

Validar linha digitável de boleto (CIP)

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns