GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Validar um boleto

Validação de boleto é um recurso no qual podemos verificar a veracidade de um Boleto emitido por outra instituição financeira ou fatura. Também é possível verificar o valor atual de uma fatura em atraso, pois taxas e juros deverão ser aplicadas a esta fatura e, o valor atualizado será retornado na requisição.

Este recurso pesquisa diretamente na CIP e procura por um registro em seu ambiente.

Caso um boleto já tenha sido pago, ou expirado, a plataforma responderá uma mensagem informando que o boleto não pode ser pago.

Usado para

  • Validar a veracidade e validade de um Boleto e/ou Fatura;
  • Verificar os valores atualizados com taxas e multas de Faturas atrasadas;

Request

GET {{BASE_URL}}/boletos/payment/validate/{{digitableLine}}
curl --location --request GET 'https://{{BASE_URL}}/boletos/payment/validate/826800000000395515852022202283300202224714052087' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-idempotence-key: 76ffdfe5-3c0c-4161-8d6c-54961f3c2abd' \
--header 'Authorization: Bearer BEARRER'

Body Response

{
    "paymentInfo": {
        "assignor": "PM PITANGUEIRAS AGUA",
        "traders": {
            "recipient": "PM PITANGUEIRAS AGUA"
        },
        "expiresAt": "2022-03-09T17:16:55.527Z",
        "totalAmount": 39.55,
        "amountDetails": {
            "calculationDate": "2022-09-03T00:00:00.000Z",
            "discount": 0,
            "fineAmount": 0,
            "interestAmount": 0,
            "paymentAmountUpdated": 39.55,
            "totalAmount": 39.55
        },
        "transactionId": 938077802,
        "type": "Dealership",
        "digitableLine": "826800000000395515852022202283300202224714052087",
        "nextBusinessDay": "09/03/2022",
        "paymentDeadline": "2022-03-09T17:16:55.527Z",
        "allowChangeValue": false,
        "initeHour": "07:00",
        "endHour": "19:00",
        "nextSettle": "N"
    }
}

campo

tipo

descição

paymentInfo.traders.recipient

string

  • Emissor do boleto ou instituição emissora da fatura

paymentInfo.traders.recipient

string

  • CNPJ do emissor

paymentInfo.traders.payerDocument

string (CPF | CNPJ)

  • CPF/CNPJ do pagador do boleto/fatura

paymentInfo.traders.payerName

string

  • Nome do pagador do boleto/fatura

paymentInfo.expiresAt

string(AAAA-MM-DD)

  • Data de expiração do boleto/fatura

paymentInfo.totalAmount

number

  • Valor do boleto/fatura

paymentInfo.amountDetails.calculationDate

string(AAAA-MM-DD)

  • Data no qual foi pago o boleto/fatura

paymentInfo.amountDetails.discount

number

  • Descontos atribuídos

paymentInfo.amountDetails.interesAmount

number

  • Taxas atribuídas

paymentInfo.amountDetails.paymentAmountUpdated

number

  • Total de (taxas + descontos + multa)

paymentInfo.amountDetails.totalAmount

number

  • Valor atualizado ( valor do boleto + total de taxas)

paymentInfo.digitableLine

string

  • Linha digitável do boleto/fatura

paymentInfo.paymentDeadline

string

  • Data de vencimento do boleto

paymentInfo.allowChangeValue

boolean

  • Indica se a fatura pode ser paga parcialmente

Did this page help you?