Rotinas Gateway
Introdução
O formulário de Rotinas Gateway é uma ferramenta essencial para o gerenciamento de cobranças do tipo Gateway e APIs de pagamento. Ele auxilia na consulta manual de status de cobranças e também no gerenciamento de alterações de cadastro de clientes que utilizam o Gateway de Pagamento da Cel payments.
Caminho: Menu Configurações > Rotinas Financeiro > Rotinas Gateway
Benefícios
- Atualização manual do status das cobranças do tipo Gateway e API
- Redução de erros manuais na verificação de pagamentos
- Melhoria na conciliação financeira
Estrutura do Formulário
O formulário de Rotinas Gateway é composto por duas abas que contém filtros de obrigatoriedade, e tem como intuito realizar requisições aos Gateways e APIs de pagamento.
Aba Consultar Recebimento
Esta aba permite preencher os filtros de busca e de cadastro de carteira, a fim de comunicar o Sistema diretamente com a integração bancária. Esta comunicação gera uma requisição ao Gateway ou API Bancária, trazendo ao Sistema os Logs Gateway, que são retornos de confirmação de status das cobranças presentes na instituição financeira (conforme o filtro de datas), a fim de atualizar seu status no sistema.
Em situações onde ocorre alguma instabilidade ou falha com o Gateway, ou API de pagamento, a consulta traz ao Sistema todas as notificações de pagamento que não foram enviadas durante o período da falha, e após o seu processamento no Sistema, suas respectivas cobranças (Contas a Receber) terão seus status atualizados.
Campos da Aba
| Campo | Descrição |
|---|---|
| Carteira de cobrança | Seleção da carteira de cobrança |
| Data inicial | Data inicial para o filtro |
| Data final | Data final para o filtro |
| Senha | Campo para inserir a senha |
Para a execução desta rotina de consulta se faz necessário a inserção de uma senha. Entre em contato com o Suporte Técnico para obter a senha ou requisitar o auxilio do suporte na execução da rotina.
Aba Alteração do cadastro no Galax Pay
Esta rotina foi criada pensando nos clientes que possuem mais de uma conta Cel payments cadastrada no Sistema. Quando surge a necessidade de alterar a Carteira de Cobrança do contrato do cliente no Sistema, e tanto a carteira antiga quanto a nova pertencem a Contas diferentes, é necessário realizar a limpeza do seu ID_Galax em seu cadastro no Sistema, assim vinculando ao Cadastro do Cliente o seu novo ID_Galax que foi gerado.
Campos da Aba
| Campo | Descrição |
|---|---|
| Cliente | Seleção ou busca de cliente |
| Senha Galax Pay | Campo para inserir a senha do Galax Pay |
Esta aba serve exclusivamente para o Gateway de Pagamento Cel payments (antiga Galax Pay).
Casos de Uso
Aba Logs consulta de pagamentos
Conceito da aba
A aba "Logs consulta de pagamentos" é uma nova funcionalidade adicionada em formato de grid para listar e armazenar todos os registros de requisições e respostas trocadas com as APIs Bancárias e Gateways de Pagamento durante as consultas de cobranças.
Objetivo funcional
O objetivo primário desta aba é otimizar o processo de diagnóstico de problemas relacionados à compensação de pagamentos. Ao registrar o tráfego de dados com as instituições financeiras, visa-se diminuir a necessidade de abertura de chamados suporte, uma vez que a análise poderá ser realizada pela própria interface do Sistema.
Integração com o fluxo atual do formulário
A funcionalidade de log atua de forma transparente, registrando as informações independentemente se a consulta for acionada de forma manual pela interface do sistema ou executada automaticamente por uma tarefa de rotina. Os logs são agrupados em registros de lote para evitar lentidão no formulário em bases com alto fluxo de informações.
Campos disponíveis
Ao selecionar um registro na grid e clicar na opção de "Visualizar", o sistema abre um novo formulário apresentando os seguintes campos:
- ID: Identificador único do log de consulta no Sistema.
- ID carteira de cobrança: A carteira de cobrança utilizada para realizar a consulta.
- Status: Indica se a consulta teve sucesso ("Consulta de pagamento concluída com sucesso.") ou falha ("Erro ao realizar consulta de pagamento.").
- Log: Descrição de status da consulta (em caso de sucesso, retornará "Consulta de pagamento concluída com sucesso").
- Método HTTP: O verbo HTTP utilizado na requisição, como GET ou POST.
- URL: O endpoint exato acionado durante a comunicação.
- Cabeçalho da requisição: Os headers enviados ao banco/gateway.
- Corpo da requisição: O body com os dados ou parâmetros da busca enviados pelo sistema.
- Corpo da resposta: O retorno bruto entregue pela integração externa (ex: dados da compensação).
- Status HTTP: O código de status da comunicação (ex: 200, 400, 500).
- Data criação: Data e hora exatas da execução da rotina ou clique no botão de consulta.
Comportamento da interface
A aba apresenta os logs listados em uma estrutura de grid. O status da consulta é destacado por um selo de cor verde quando indica "Sucesso". Dentro da tela de visualização do registro, existe um botão dedicado para copiar instantaneamente o conteúdo completo da requisição para a área de transferência do usuário, já devidamente formatado em JSON.
Regras de negócio
As requisições geradas por uma rotina de consulta são consolidadas para salvar apenas um log de lote que contenha as requisições, melhorando a performance de consulta. Sempre que uma das tarefas de consulta for acionada, o log deve ser gerado contendo um "Número da consulta" para garantir rastreabilidade das diferentes chamadas e páginas pertencentes à mesma ação.
Fluxo de uso passo a passo
- O usuário acessa o menu de Rotinas
Gateway. - Executa normalmente a consulta preenchendo as informações e dados necessários.
- O sistema envia a requisição para a API bancária correspondente e recebe a resposta.
- O sistema grava automaticamente essas interações nos registros de log.
- O usuário acessa a aba "Logs consulta de pagamentos" no formulário da rotina.
- O usuário seleciona a linha desejada na grid e aciona o botão de Visualizar para auditar a requisição e a resposta, ou copiar o JSON da transação.
Exemplos práticos reais
Cenário: As liquidações Pix não entram no sistema mesmo o usuário rodando a rotina. Uso do recurso: Através da listagem da aba "Logs consulta de pagamentos", a equipe responsável por suporte identifica que, embora a Rotina rode no sistema, a API da instituição financeira está respondendo com um status de código indicando erro no serviço. O problema da instituição fica claro em minutos, contornando a necessidade de solicitar testes de código.
Cenários de erro possíveis
Quando o Token de autorização expirar ou a API do Pix estiver fora do ar, o sistema irá capturar e persistir a tentativa. O campo de "Status" mudará para "Falha", e simultaneamente, o Corpo da Resposta descreverá o erro bruto exibido pela instituição.
Impactos no processo de consulta de pagamento
Agiliza a detecção de instabilidades e garante profunda independência durante o suporte para problemas diários com Pix, aumentando consideravelmente o poder e velocidade de resolução e manutenção nas conciliações de pagamentos.
Para as integrações Pix presentes (modobank e Efí), o fluxo realiza um apontamento específico que rastreia a quantidade exata de requisições que ocorrem durante cada evento consultivo, e, caso essas integrações tragam dados fatiados por paginação, a quantidade de páginas é processada e armazenada de acordo com suas adaptações na arquitetura do desenvolvimento.
Considerações Finais
O formulário de Rotinas Gateway é uma ferramenta fundamental para manter a integridade e atualização dos dados financeiros no sistema. Ao automatizar o processo de verificação e atualização de status das cobranças, esta rotina contribui significativamente para a eficiência operacional e a precisão dos registros financeiros da empresa.