Pagamentos- Consultar informações de convênio
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 convênios, facilitando a transparência e a gestão eficiente de obrigações financeiras.
Funcionalidades Essenciais:
- Identificação de Convênios: Os usuários podem identificar o convênio que desejam consultar utilizando identificadores exclusivos, como número do convênio.
- Recuperação de Detalhes do Convênio: Uma vez identificado o convênio, a API recupera e retorna informações abrangentes sobre o mesmo, incluindo:
- Status do convênio (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 convênio.
Requisição
| Campo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| linhaDigitavel | Texto | Código de pagamento | Sim |
| cpfOperador | Texto | CPF do recebedor | Sim |
| contaOrigem | Texto | Conta da qual se origina o pagamento com o digito verificador. | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| message | Texto | Mensagem da consulta |
| id | Texto | Identificador do convênio consultado |
| date_pay | Texto | Data de pagamento do convênio |
| date_due | Texto | Data de vencimento do convênio |
| limit_date | Texto | Data limite do convênio |
| amount | Texto | Valor do convênio |
| interest | Texto | Juros |
| fines | Texto | Multas |
| discount | Texto | Desconto aplicado do convênio |
| total_amount | Texto | Valor total do convênio |
| Receiver - name | Texto | Nome do destinatário |
| Receiver - cpf_cnpj | Texto | CPF ou CNPJ do destinatário |
| Issuer - name | Texto | Nome do emissor |
| numeroOperacao | Texto | Número da operação |