Pular para conteúdo

Comunicação Bancária

cobranças

Durante muitos anos, a troca de informações financeiras entre empresas e bancos foi realizada exclusivamente por meio do padrão CNAB (Centro Nacional de Automação Bancária). Embora esse modelo tenha viabilizado a integração entre as instituições, ele sempre esteve associado a ineficiências operacionais, riscos e alto custo operacional, como:

  • Processos manuais — geração, envio e processamento de arquivos feitos manualmente, sujeitos a erros frequentes
  • Complexidade técnica — necessidade de conhecimento profundo das particularidades e layouts específicos de cada banco
  • Riscos de segurança — transporte e armazenamento de arquivos com dados sensíveis de forma pouco controlada
  • Baixa agilidade — ciclos de envio, processamento e retorno que podem levar horas ou até dias

O módulo de Comunicação Bancária da soulsys plataforma foi desenvolvido para eliminar essas limitações. A solução abstrai completamente a complexidade técnica e as particularidades de cada instituição financeira, oferecendo uma comunicação automática, segura e em tempo real com os bancos.

Com isso, a plataforma reduz drasticamente falhas operacionais, aumenta a confiabilidade das informações e proporciona muito mais agilidade, segurança e controle nos processos financeiros da empresa.

Conceito

conceito do módulo de comunicação bancária

O módulo atua como um portal de integração — ou gateway, no termo técnico — entre os sistemas corporativos da empresa e as instituições bancárias.

Por meio de um protocolo unificado, a soulsys plataforma simplifica e padroniza o processo de registro de cobranças e o tratamento dos eventos de retorno, como liquidações, baixas e confirmações de pagamento.

Todo o fluxo ocorre em tempo real e de forma automatizada, eliminando a necessidade de intervenções manuais e reduzindo drasticamente erros operacionais, atrasos e riscos no processo financeiro.

Principais Recursos

  • Contas bancárias — gestão centralizada das contas bancárias e dos parâmetros de integração com os principais bancos brasileiros.
  • Cobranças — registro automático, acompanhamento e controle do status das cobranças em tempo real.
  • Boletos e Pix (Bolecode) — geração de boletos com código de barras tradicional e QR Code Pix, oferecendo mais opções e conveniência para pagamento.
  • Envio de links por e-mail — envio de links com códigos de segurança, em substituição ao anexo em PDF, para reduzir riscos de fraude.
  • Comunicação em tempo real — processamento online de todos os eventos bancários, garantindo agilidade, confiabilidade e atualização imediata das informações.
  • Integração com sistemas ERP — envio de eventos e notificações por meio de webhooks, permitindo integração nativa com ERPs e outros sistemas corporativos.
  • Rastreabilidade completa — registro detalhado da linha do tempo de todos os eventos de comunicação entre a plataforma, os sistemas internos e as APIs bancárias.

Contas Bancárias

contas bancárias

O cadastro de Contas Bancárias permite registrar todas as contas utilizadas no processo de cobrança. A plataforma consolida, em um único local, as contas de diferentes empresas e instituições financeiras, facilitando a administração, a padronização e o controle das informações bancárias.

Adicionar

Para cadastrar uma nova conta bancária, clique no botão Adicionar na página de Contas Bancárias.

Visão Geral

adicionar conta bancária

A aba Visão Geral permite definir a empresa vinculada e os dados da conta bancária que será utilizada no processo de cobrança.

O campo Descrição é utilizado para facilitar a identificação da conta nas telas da plataforma.

Já o campo Identificador deve ser utilizado para definir um código interno da conta, empregado nas integrações com outros sistemas e nos fluxos automatizados da plataforma.

Dica: Para evitar inconsistências durante as integrações, recomendamos utilizar o padrão snake case (palavras em minúsculas separadas por sublinhado _) ao definir o identificador da conta.
Exemplo: itau_matriz.

Bancos Homologados

Atualmente, o módulo permite a configuração de contas dos seguintes bancos:

  • Banco do Brasil
  • Bradesco
  • Inter
  • Itaú
  • Santander

Importante: A soulsys realiza a homologação de novos bancos sem custo adicional para o cliente, desde que a instituição financeira disponibilize APIs documentadas para registro de cobranças e envio de webhooks.

Configurações

configurações da conta bancária

A aba Configurações permite a definição das configurações técnicas de integração com a API do banco em questão.

Os campos são apresentados dinamicamente e refletem todos os parâmetros necessários para o registro das cobranças e o recebimento de eventos (webhooks).

API

seção API

A seção API permite definir todos os parâmetros necessários para a comunicação com a API de cobranças do banco.

Normalmente, essa seção contém as URLs e as credenciais utilizadas para a autenticação da soulsys plataforma no sistema do banco.

Cobrança

seção cobrança

A seção Cobrança define as configurações de cobrança permitidas pelo banco, como carteira, juros e multa.

Recebimento de Webhooks

recebimento de webhooks

Para que seja possível receber os webhooks disparados pelo banco, é necessário cadastrá-lo como um usuário da plataforma . Em seguida, selecione o banco na lista exibida pelo campo Sistema.

No ambiente de configuração de envio de webhooks do banco, informe a seguinte URL:

https://seu-servidor-da-plataforma.com.br/api/sys/charges/webhooks?authToken=TOKEN

Informe o token gerado para o banco no parâmetro authToken.

Envio de Webhooks

envio de webhooks

Quando as cobranças são registradas automaticamente por outro sistema (normalmente o ERP da empresa), é comum que esse sistema precise receber eventos relacionados à cobrança, como liquidação ou cancelamento.

Para notificar outros sistemas sobre os eventos das cobranças criadas na plataforma, utilize a seção Envio de Webhooks.

O campo URL deve conter o endereço da API que irá receber uma requisição POST com os dados do evento.

Para mais detalhes sobre os dados enviados, consulte a documentação técnica do módulo de comunicação bancária.

Caso a API que irá receber os webhooks necessite de autenticação, utilize o campo Headers para definir um array contendo todos os headers que devem ser enviados na requisição.

Testar configurações

testar configurações

Após definir todas as configurações da conta bancária, é possível verificar se tudo está funcionando corretamente utilizando o botão Testar configurações.

O teste consiste em registrar uma cobrança de teste e cancelá-la em seguida, utilizando todas as configurações definidas.

Caso ocorra alguma falha, o sistema exibirá a mensagem de erro retornada pela API do banco.

Filtrar

filtrar

A página de gestão de contas bancárias permite localizar contas de forma rápida e prática por meio da seção Filtrar.

A busca pode ser realizada pelos campos Banco, Agência, Conta ou Descrição.

Cobranças

cobranças

A página Cobranças permite o registro e o controle centralizado das cobranças de todas as empresas e instituições bancárias que fazem parte do ecossistema do cliente.

Nova cobrança

Para criar uma nova Cobrança, clique no botão Adicionar, localizado na parte superior do grid de cobranças.

Dados da cobrança

dados da cobrança

A seção Dados da cobrança permite definir as principais informações da cobrança, como a conta bancária e um código de identificação.

O botão Mais informações exibe campos adicionais, como multa, desconto e dias para protesto. Essas informações são carregadas automaticamente a partir da conta bancária selecionada, permitindo ajustes quando necessário.

Pagador

pagador

O cliente que receberá a cobrança é definido na seção Pagador. É possível informar o CNPJ/CPF diretamente ou clicar no botão com o ícone de lupa para pesquisar entre os clientes já cadastrados.

Para cadastrar um novo pagador, clique no botão Cadastrar. Para alterar os dados do pagador selecionado, utilize o botão Atualizar.

Mensagens

mensagens

Utilize o card Mensagens para cadastrar mensagens adicionais que serão exibidas na seção Informações de responsabilidade do beneficiário dos boletos.

Detalhes da cobrança

detalhes da cobrança

Ao clicar em uma cobrança no grid, será exibida a página de Detalhes da cobrança.

Essa página apresenta todas as informações necessárias para a identificação do registro, a análise do ciclo de vida da cobrança e a execução de ações, como a geração de PDFs de boletos e o envio de instruções de cobrança aos bancos.

Status

As cobranças controladas pelo módulo podem assumir os seguintes status:

 Não registrada — cobrança ainda não enviada ao banco.

 Em processamento — aguardando retorno do banco sobre o processamento.

 Registrada — cobrança registrada com sucesso no banco.

 Cancelada — cobrança cancelada por um usuário ou sistema.

 Recebida — confirmação de pagamento recebida a partir do banco.

Ações

Registrar

registrar cobrança

Utilize a opção Registrar para enviar a cobrança ao banco.

Após o registro, será possível gerar o PDF do boleto ou enviar um link para acesso ao boleto por e-mail.

Caso ocorra alguma falha no processo de registro, o sistema exibirá a mensagem de erro retornada pelo banco.

Boleto

botão boleto

Cobranças com status Registrada habilitam a opção Boleto, utilizada para executar ações relacionadas ao PDF do boleto.

Gerar PDF

Exibe o PDF do boleto em uma nova aba do navegador.

pdf do boleto

O logotipo e a cor da faixa superior do boleto são personalizáveis.

A seção de comunicados é opcional e pode ser utilizada para exibir informações importantes ao cliente.

Dica: Verifique se o bloqueador de pop-ups do seu navegador não está configurado para impedir a abertura automática de arquivos PDF.

Enviar por e-mail

Envia um e-mail ao pagador contendo um link para acesso ao PDF do boleto.

corpo do e-mail

O link é protegido por um código de segurança de seis dígitos, informado no corpo da mensagem. O layout do e-mail pode ser personalizado de acordo com as necessidades de cada cliente.

Instruções

instruções de cobrança

A opção Instruções permite gerenciar instruções de cobrança junto aos bancos.

As ações disponíveis podem variar de acordo com as instruções permitidas por cada instituição bancária.

Alterar vencimento

Permite alterar a data de vencimento da cobrança.

Cancelar

Cancela a cobrança junto ao banco e altera o status do registro para Cancelada.

Copiar

copiar cobrança

Inicia a criação de uma nova cobrança a partir dos dados da cobrança selecionada.

Visão geral

visão geral

A aba Visão geral apresenta as informações gerais da cobrança.

Linha do Tempo
linha do tempo

Destaque para a seção Linha do Tempo, que exibe a sequência de eventos relacionados ao ciclo de vida do registro.

O sistema indica a pessoa ou o sistema responsável pelo evento, bem como a data e o horário da ocorrência.

Eventos

eventos

Todos os eventos relacionados à cobrança selecionada podem ser consultados na aba Eventos da página de detalhes da cobrança.

Detalhes do evento

detalhes do evento

Ao clicar em um evento, a plataforma exibirá os detalhes do registro selecionado.

O campo Payload apresenta o JSON enviado ou recebido, facilitando a rastreabilidade e a análise de eventuais falhas.

Webhooks

webhooks

Caso a conta bancária da cobrança esteja configurada para envio de webhooks , a aba Webhooks exibirá todos os eventos enviados para a URL configurada.

O campo Status indica se o webhook foi entregue com sucesso ao sistema de destino.

Detalhes do webhook

detalhes do webhook

Ao clicar em um webhook, o sistema exibirá os detalhes do registro selecionado.

O campo Payload apresenta os dados enviados, enquanto o campo Response exibe os dados retornados pela aplicação de destino.

Filtrar

filtrar cobranças

A seção Filtrar permite localizar rapidamente cobranças criadas na plataforma.

O sistema possibilita a combinação de diferentes critérios de filtro, como Status, Conta, Pagador e período de Vencimento.

Informações Técnicas

Consulte a documentação técnica do módulo de comunicação bancária para obter detalhes adicionais sobre integrações, pontos de entrada e recursos avançados.