v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Pagamentos

Consultar informações de um Boleto/Conta de Consumo

Pagamentos- Consultar informações de um boleto/conta de consumo<br/>Permite que usuários autorizados acessem e recuperem detalhes sobre acordos específicos registrados em um sistema de pagamentos ou portal do governo. Essa funcionalidade oferece uma maneira segura e padronizada de consultar informações de boletos/contas de consumo, facilitando a transparência e a gestão eficiente de obrigações financeiras.<br/><br/>Funcionalidades Essenciais:<br/>- Identificação de Boleto/Conta de Consumo: Os usuários podem identificar o boleto/conta de consumo que desejam consultar utilizando identificadores exclusivos, como número do boleto/conta de consumo.<br/>- Recuperação de Detalhes do Boleto/Conta de Consumo: Uma vez identificado o boleto/conta de consumo, a API recupera e retorna informações abrangentes sobre o mesmo, incluindo:<br/>- Status do boleto/conta de consumo (ativo, inativo, expirado, etc.)<br/>- Partes envolvidas (pagador, recebedor, intermediários)<br/>- Termos e condições de pagamento (valor, parcelas, datas de vencimento)<br/>- Histórico de pagamentos (transações, faturas, ajustes)<br/>- Documentos associados (contratos, aditivos, autorizações)<br/>- Controle de Acesso de Dados: A API implementa mecanismos rígidos de controle de acesso para garantir que apenas usuários autorizados com as permissões adequadas possam acessar informações confidenciais do boleto/conta de consumo.<br/><br/> Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>linhaDigitavel</td><td>Texto</td><td>Linha Digitável</td><td>Sim</td></tr><tr><td>cpfOperador</td><td>Texto</td><td>CPF do recebedor</td><td>Sim</td></tr><tr><td>contaOrigem</td><td>Texto</td><td>Conta da qual se origina o pagamento com o digito verificador.</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem da consulta </td></tr><tr><td>id</td><td>Texto</td><td>Identificador do boleto/conta de consumo consultado </td></tr><tr><td>date_pay</td><td>Texto</td><td>Data de pagamento do boleto/conta de consumo </td></tr><tr><td>date_due</td><td>Texto</td><td>Data de vencimento do boleto/conta de consumo </td></tr><tr><td>limit_date</td><td>Texto</td><td>Data limite do boleto/conta de consumo </td></tr><tr><td>amount</td><td>Texto</td><td>Valor do boleto/conta de consumo </td></tr><tr><td>interest</td><td>Texto</td><td>Juros </td></tr><tr><td>fines</td><td>Texto</td><td>Multas </td></tr><tr><td>discount</td><td>Texto</td><td>Desconto aplicado do boleto/conta de consumo </td></tr><tr><td>total_amount</td><td>Texto</td><td>Valor total do boleto/conta de consumo </td></tr><tr><td>Receiver - name</td><td>Texto</td><td>Nome do destinatário </td></tr><tr><td>Receiver - cpf_cnpj</td><td>Texto</td><td>CPF ou CNPJ do destinatário </td></tr><tr><td>Issuer - name</td><td>Texto</td><td>Nome do emissor </td></tr><tr><td>numeroOperacao</td><td>Texto</td><td>Número da operação </td></tr></tbody></table>

post/api/v1/pagamento/consulta/boleto

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

linhaDigitavelstring
cpfOperadorstring
contaOrigemstring

Example request

{
  "linhaDigitavel": "000000000000000000000000000000000000000000000000",
  "cpfOperador": "00000000000",
  "contaOrigem": "0550000000"
}

Response

Sucesso na consulta.

messagestring

Example response

{
  "message": "Sucesso na consulta."
}