v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBRealizar a criação de uma transação de um boleto/conta de consumo
Pagamento- Realizar a criação de uma transação de boleto/conta de consumo<br/>Permite que usuários autorizados iniciem e registrem transações financeiras relacionadas a boletos/contas de consumo específicos registrados em um sistema de pagamentos ou portal do governo. Essa API facilita o processamento eficiente de pagamentos associados a boletos/contas de consumo, garantindo o cumprimento pontual das obrigações financeiras e promovendo a transparência nas transações financeiras.<br/><br/>Funcionalidades Essenciais:<br/>- Iniciação de Transações: Os usuários podem iniciar novas transações fornecendo detalhes essenciais, como:<br/>- Identificador do boleto/conta de consumo (ID único, número de referência)<br/>- Registro de Transações: Uma vez iniciada, a API registra a transação no sistema de pagamentos, gerando um identificador de transação único e registrando detalhes relevantes.<br/>- Atualizações de Contas: A API atualiza os registros contábeis associados ao boleto/conta de consumo, refletindo o impacto da transação no saldo pendente e no histórico de pagamentos.<br/>- Geração de Trilha de Auditoria: A API gera uma trilha de auditoria para cada transação, documentando os processos de iniciação, aprovação e conclusão da transação.<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><tr><td>senhaMovimentacao</td><td>Texto</td><td>Senha de movimentação do operador utilizada na plataforma de pagamento </td><td>Sim</td></tr><tr><td>dataAgendamento</td><td>Texto</td><td>Data do agendamento do pagamento </td><td>Não</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 para comprovação do pagamento</td></tr><tr><td>Data - transaction</td><td>Texto</td><td>Código da transação</td></tr></tbody></table>
Headers
Client ID enviado no Header
Request body
Example request
{
"linhaDigitavel": "000000000000000000000000000000000000000000000000",
"cpfOperador": "00000000000",
"contaOrigem": "0550000000",
"senhaMovimentacao": "******",
"dataAgendamento": "YYYY-MM-DD"
}Response
Pagamento enviado para aprovação.
Example response
{
"message": "Pagamento enviado para aprovação.",
"data": [
{
"transaction": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
}