Central de Ajuda

Aparência

Carteiras de APIs Bancárias ​

Introdução ​

A Integração via API Bancária conecta o Sistema diretamente às instituições financeiras, modernizando a camada de pagamentos e cobranças. Esta documentação apresenta uma visão geral das integrações bancárias disponíveis e suas principais características.

Benefícios ​

A comunicação via API substitui a troca manual de arquivos (CNAB), proporcionando uma gestão financeira em tempo real.

  • Automação Total: Eliminação do fluxo manual de arquivos de remessa e retorno.
  • Boleto Híbrido: Emissão de boletos com QR Code Pix integrado, permitindo liquidação imediata.
  • Registro Instantâneo: O título é registrado no banco no momento da emissão pelo Sistema.
  • Baixa Automática: O reconhecimento do pagamento ocorre de forma automática, agilizando a conciliação bancária.

APIs Bancárias Disponíveis ​

Integrações

Enviar Template Cobrança Pix via WhatsApp com o Opa! Suite ​

A integração do sistema com a plataforma de mensagens WhatsApp, em parceria com a Meta e OPA! Suite, abre novas possibilidades para a comunicação com seus clientes. Uma dessas funcionalidades é o envio detalhado de informações de cobrança Pix diretamente pelo aplicativo de mensagens WhatsApp. A funcionalidade está disponível em Sistema para carteiras de cobrança do tipo Gateway e Pix.

Quando configurado, seu Sistema estará habilitado para enviar um template otimizado de cobranças Pix ao seu cliente por meio da integração com o Opa! Suite.

Dica!

Para mais detalhes da funcionalidade e configuração, verifique em Enviar Template Cobrança Pix via WhatsApp com o Opa! Suite.

Webhook ​

O webhook é um recurso tecnológico que possibilita a comunicação automática entre o banco e o sistema, garantindo atualizações em tempo real sobre instruções de cobrança, como liquidações e cancelamentos. Todas as integrações citadas acima agora disponibilizam a comunicação via webhook.

Funcionamento ​

Sempre que houver uma atualização no status de uma transação registrada junto ao banco (por exemplo, um pagamento via Pix ou boleto confirmado), o banco enviará automaticamente um log de comunicação para o sistema por meio do webhook.

Essa comunicação direta reduz a dependência de processos manuais ou consultas programadas, garantindo que as informações estejam sempre atualizadas em menos tempo.

Benefícios do Webhook ​

Agilidade no processamento: ​

  • Pagamentos via Pix serão recebidos no sistema imediatamente após a instituição financeira disponibilizar sua liquidação (o tempo de processamento pode variar conforme a instituição).
  • Pagamentos via boleto, anteriormente sujeitos a uma carência de 1 dia útil, agora serão compensados no sistema em 30 minutos ou mais, também dependendo da confirmação do banco.

Automação e eficiência: ​

  • Dispensa a necessidade de processamento manual de arquivos de retorno bancário.
  • Atualizações instantâneas garantem maior controle sobre o fluxo financeiro.
Observação

O prazo para recebimento da compensação é gerenciado exclusivamente pelo Banco e pode variar conforme cada instituição financeira.

Segurança ​

Aviso!

O campo usado para a Credencial/Token da API será criptografado assim que inserido na carteira de cobrança. Além disso, seu conteúdo será exibido como campo de senha, tanto na carteira de cobrança quanto na auditoria. Essa medida foi implementada para aumentar a segurança e evitar acessos não autorizados às suas credenciais.

Se houver alterações na aplicação de API ou nesse campo na carteira de cobrança, a Credencial/Token deverá ser copiada novamente na aplicação da API correspondente e reinserida na carteira de cobrança para que a autenticação funcione corretamente.

Garantia da Consulta de Pagamentos ​

Apesar da implementação do webhook, recomenda-se a manutenção de um horário configurado para a execução das tarefas de Consulta de Pagamento API. Essa tarefa atuará como um mecanismo de segurança, garantindo que qualquer liquidação eventualmente não recebida em tempo real seja identificada e processada no dia seguinte.

Tarefa Consulta API!

Confira nos tópicos abaixo como configurar as tarefas de confirmação de baixa para as APIs que disponibilizam o Webhook.

Implementado o cancelamento unitário de boletos de forma síncrona:

  • Implementada nova funcionalidade que, ao efetuar o pagamento de uma cobrança por meio alternativo (gateway, Pix, recebimento manual ou pagamento com cartão de crédito), realiza o cancelamento da cobrança principal de forma síncrona, assegurando a eliminação de falhas no processamento das filas de cancelamento. Em caso de erro durante o cancelamento, a cobrança será inserida em uma fila para uma nova tentativa.

Considerações Finais ​

As integrações de APIs bancárias no Sistema oferecem uma maneira eficiente de gerenciar operações financeiras e processos de cobrança. Ao configurar e utilizar essas integrações corretamente, é possível otimizar fluxos de trabalho e melhorar a eficiência operacional da empresa.

Leia Também ​

Disponibilizado por IXC S.A.

© 2025