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

Pagamentos- Consultar informações de um boleto/conta de consumo
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.

Funcionalidades Essenciais:
- 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.
- 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:
- Status do boleto/conta de consumo (ativo, inativo, expirado, etc.)
- Partes envolvidas (pagador, recebedor, intermediários)
- Termos e condições de pagamento (valor, parcelas, datas de vencimento)
- Histórico de pagamentos (transações, faturas, ajustes)
- Documentos associados (contratos, aditivos, autorizações)
- 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.

Requisição

CampoTipoDescriçãoObrigatoriedadelinhaDigitavelTextoLinha DigitávelSimcpfOperadorTextoCPF do recebedorSimcontaOrigemTextoConta da qual se origina o pagamento com o digito verificador.Sim

Resposta
CampoTipoDescriçãomessageTextoMensagem da consulta idTextoIdentificador do boleto/conta de consumo consultado date_payTextoData de pagamento do boleto/conta de consumo date_dueTextoData de vencimento do boleto/conta de consumo limit_dateTextoData limite do boleto/conta de consumo amountTextoValor do boleto/conta de consumo interestTextoJuros finesTextoMultas discountTextoDesconto aplicado do boleto/conta de consumo total_amountTextoValor total do boleto/conta de consumo Receiver - nameTextoNome do destinatário Receiver - cpf_cnpjTextoCPF ou CNPJ do destinatário Issuer - nameTextoNome do emissor numeroOperacaoTextoNúmero da operação

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
Headers
uuid
required

Client ID enviado no Header

Responses

401

Invalid client data.

403

Invalid token.

422

Invalid input fields.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json