Validação do título

A validação do título ocorre por meio da linha digitável e é a primeira etapa do processo de pagamento de conta, pois ela verifica se o título está apto a ser pago.

Neste momento, verificamos se o título:

• já foi pago anteriormente;
• é recebível na instituição;
• está dentro da data mínima para adiantamento;
• possibilita pagamento parcial;
• não atingiu o limite de pagamentos parciais;
• exige pagamento mínimo ou máximo;
• está dentro da data limite de pagamento;
• pode ser pago após a data de vencimento;
• possui multa, juros e/ou descontos;
• está dentro do valor máximo que pode ser pago, sendo o valor de R$249.999,99 para ficha de compensação e R$950.000,00 para concessionária, tributos e convênio.

Também checamos se o beneficiário do boleto está apto para receber o pagamento.

📘

Nota

A quantidade de pagamentos parciais que um boleto aceita é configurável no momento do seu registro.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

• O título esteja registrado na CIP (Câmara Interbancária de Pagamentos).

Requisição

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/bill-payment/validate

--curl --request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/bill-payment/validate' \
--header 'accept: application/json' \
--header 'api-version: 1.0' \
--header 'authorization: Bearer {{Token}}' \
--header 'content-type: application/*+json' \
--header 'x-correlation-id: GUID' \
--data '{
   "code":"{{linha digitável}}"
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie o seguintes campo em formato JSON:

{ 
  "code": "{{linha digitável}}",
}

Resposta (Response)

O status code 200 indicará que a linha digitável foi validada com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

📘

Nota

O campo settleDate apresenta um valor dinâmico, pois exibe a data em que será feita a conciliação do pagamento. Por exemplo, caso o boleto seja pago no dia 03/10/2022 (dia útil) dentro do horário limite, o settleDate apresentará o valor 03/10/2022, que é o dia em que o pagamento será liquidado. No entanto, se o boleto for pago no dia 01/10/2022 (sábado), o settleDate apresentará o valor 03/10/2022, que é o próximo dia útil que permitirá sua liquidação.

{
   "id": "61854f59-7379-4a3b-b699-91899c6f6743",
   "assignor": "Acesso Soluções de Pagamento S.A.",
   "recipient": {
      "name": "Maria Quitéria de Jesus",
      "documentNumber": "099.922.200-74"
   },
   "payer": {
      "name": "Nísia Floresta",
      "documentNumber": "477.426.630-23"
   },
   "businessHours": {
      "start": "07:00",
      "end": "23:00"
   },
   "dueDate": "2022-03-20T00:00:00",
   "settleDate": "2022-03-17T00:00:00",
   "nextSettle": false,
   "originalAmount": null,
   "amount": 895.59,
   "charges": {
      "interestAmountCalculated": 0,
      "fineAmountCalculated": 0,
      "discountAmount": 0
   },
   "maxAmount": 1791.09,
   "minAmount": 0.08,
   "allowChangeAmount": true,
   "digitable": "00190000090280316401743442449222100000000000000"
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400.

🚧

Importante

Por segurança, o parceiro tem até 20 minutos a partir da validação para confirmar o pagamento. Caso contrário, irá receber o erro 404 - BILL_PAYMENT_NOT_FOUND_FOR_SUPPLIED_ID e precisará realizar a validação novamente para prosseguir.

Eventos

Este endpoint não possui eventos relacionados a ele.