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
Resposta
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Invalid client data.
403Invalid token.
422Invalid input fields.
