Central de Ajuda

Leitura de 8 min

Integração Bancária Efí

Este documento apresenta instruções detalhadas sobre a integração e utilização do Gateway do Efí, incluindo a configuração do Webhook para notificações em tempo real.

O Gateway permite a automação de processos bancários, enquanto o Webhook assegura atualizações instantâneas sobre transações e eventos.

Requisitos Importantes

  • Sistema operacional Debian 10.
  • Para a homologação de uma carteira Gateway o indicado é abrir um novo convênio de conta bancária. Caso deseje utilizar um que já esteja em uso no IXC e/ou que já tenha boletos emitidos por ele, deve estar ciente de que podem ocorrer divergências nos relatórios provenientes de arquivos de retorno.
    Entre as divergências estão: Informação de Título não encontrado nos processamentos de retorno (quem se referem a títulos da carteira de Gateway), liquidações atreladas a boletos divergentes, etc.

Objetivos da Integração

  • Ampliar a gama de integrações disponíveis no sistema.
  • Atender aos pedidos dos clientes da Efí que buscam compatibilidade com o sistema.
  • Implementar a geração automática de boletos híbridos e otimizar o processamento de baixas de pagamentos de forma integrada e eficaz.
  • Oferecer mais uma opção de integração, garantindo flexibilidade na escolha de soluções financeiras.

Benefícios da Integração

1. Automação de Processos

  • Baixa automática de pagamentos: Os pagamentos realizados serão baixados automaticamente no sistema, garantindo maior precisão e economia de tempo.

2. Economia e Eficiência

  • Redução de custos: Com tarifas competitivas da Efí, os clientes economizam em transações financeiras enquanto utilizam uma solução integrada.
  • Centralização de operações: Permite gerenciar boletos e pagamentos em uma única plataforma, eliminando a necessidade de múltiplos sistemas e fornecedores.

3. Melhor Experiência para o Cliente

  • Solicitação atendida: Atende à demanda dos clientes que já possuem contas na Efí e desejam manter seus serviços integrados ao sistema.
  • Facilidade de adoção: A integração foi desenvolvida para ser intuitiva e de fácil implementação, permitindo que os clientes a utilizem imediatamente.

4. Vantagem Competitiva

  • Maior atratividade do sistema: A disponibilização dessa integração torna a plataforma mais atraente para novos clientes que utilizam ou desejam aderir à Efí.
  • Retenção de clientes: Ao oferecer soluções alinhadas às necessidades dos usuários, o sistema contribui para o aumento da satisfação e retenção de clientes.

Dica!

Caso ainda não tenha uma Conta Efí, acesse o link abaixo e consiga um desconto especial através de nossa parceria:

Atenção, Beta!

Este conteúdo está presente na versão Beta. Sua disponibilidade na versão Master será a partir de Abril de 2025.

Melhoria:

  • Anteriormente, logs de pagamento permaneciam em estado pendente/aguardando por até 3 horas para processamento, devido à necessidade de uma tarefa predefinida no Servidor.
  • Agora, os logs de pagamento do Gateway Efí são processados imediatamente após sua chegada ao Sistema, como já ocorre com os Gateways Lytex, Asaas e Banco do Brasil, por exemplo.

Processo de Integração e Homologação

Para realizar a integração e homologação do Gateway Efí no sistema, siga estes passos:

Homologação

Dados bancários necessários para a integração:

364 - Efí (Gateway)

  • 1 - Número da agência com dígito?
  • 2 - Número da conta com dígito?
  • 3 - Client_ID?
  • 4 - Client_Secret?
  • 5 - Identificador da conta?

Dica!

Caso tenha dúvida sobre algum dos dados bancários, consulte o(a) Gerente de sua Conta Bancária.

Passo a Passo para Obter as Credenciais do Gateway

  1. Acesse o Internet Banking Efí Bank.
  2. Faça login com sua conta.
  3. No menu lateral esquerdo, clique na opção API.
  4. Na seção de Introdução, clique em Criar Aplicação.
  5. Insira um nome para sua aplicação, exemplo: Efí - IXC, e clique em Continuar.
  6. No menu de escopos, submenu API Cobranças, marque a opção Emissão de cobranças.
  7. No submenu API Pix, marque todas as caixas de seleção das colunas Produção e Homologação, exceto a opção Consultar Saldo.
  8. Clique no botão Continuar.
  9. Insira a Assinatura Eletrônica da sua Conta Efí.
  10. No menu Introdução, clique em Minhas Aplicações.
  11. Localize a aplicação criada, clique no botão Ações à direita e selecione Detalhar.
  12. Copie as credenciais de API:
  • Chave Client ID
  • Chave Client Secret

Obtendo o Identificador da Conta

  1. No menu API, clique em Introdução.
  2. Na tela Introdução, clique no botão Identificador da Conta.
  3. Será exibida uma pequena janela contendo o Identificador da Conta.
  4. Copie esse código, pois ele será utilizado na criação da carteira, juntamente com as outras credenciais.

Credenciais Gateway Finalizadas!

Com essas informações e os dados bancários necessários, um atendente da IXC Soft poderá prosseguir com a homologação da sua carteira de cobrança Gateway.

Criando a Carteira

  1. Acesse o menu Sistema.
  2. Vá até a pasta Financeiro.
  3. Clique em Carteira de Cobrança.
  4. Clique em Novo.
  5. Na aba Carteira de Cobrança, configure os seguintes campos:
    • Descrição: Defina o nome da carteira.
    • Conta: Criação da conta responsável pelo armazenamento dos dados bancários.
    • Tipo de recebimento: Selecione Gateway.
    • Enviar e-mail para cliente ao gerar: Marque Não, pois essa opção obriga o envio automático da fatura e seu registro no banco.
    • Validar filial na venda: Marque Sim.
    • Planejamento analítico: Utilize o padrão 240 ou crie um novo.

Criando a Conta

  • Conta: Defina o nome da conta.
  • Tipo da Conta: Selecione Banco.
  • Data de abertura: Informe a data de configuração da conta vinculada à carteira.
  • Planejamento analítico: Consulte mais detalhes em Formulário Planejamento Analítico.
  • Filial associada à conta.

Na aba Banco, configure:

  • Banco: Selecione 364 - Gerencianet Pagamentos do Brasil.
  • Agência: Número da agência bancária.
  • Dígito verificador da agência: Digite o DV da agência.
  • Número da conta: Número da conta bancária.
  • Dígito verificador da conta: Informe o DV da conta bancária.

Configurações Gateway

  • Gateway: Selecione Efí.
  • Ambiente Gateway: Selecione Produção.
  • Client_ID: Insira o código gerado na Conta Efí.
  • Client_Secret: Insira o código gerado na Conta Efí.
  • Identificador: Insira o Identificador da Conta copiado anteriormente.
  • Call-back: Após salvar a carteira pela primeira vez, clique no botão Gerar para criar o endereço URL, que servirá como ponte de comunicação entre o Gateway de pagamento e o sistema.

Cuidado!

O URL Call-back é essencial para que o Gateway envie logs (webhooks) sobre cobranças e recebimentos ao sistema. Se o domínio da base for alterado, será necessário gerar um novo URL Call-back e solicitar o ajuste junto ao suporte do banco Efí.

  • Enviar e-mail Gateways: Marque Não.
  • Gera Pix: Marque Sim, se desejar ativar o Pix nos boletos.
  • Tarifas Gateway: Definir o lançamento das tarifas, pois o banco não realiza isso automaticamente. Para mais informações, consulte Tarifas Bancárias - Gateway, API e Pix.

Aviso!

Exclusivamente para o Gateway Efí, o parâmetro Gera Pix é apenas visual. O que define a geração do QR Code Pix é uma configuração feita diretamente na Conta Bancária Efí.

Juros, Multas e Desconto

  • Juros %: Configure 0,033% (máximo permitido por lei).
  • Multa %: Configure 2% (máximo permitido por lei).
  • Desconto até o vencimento (R$): Defina um valor fixo para descontos antes do vencimento.
  • Desconto até o vencimento (%): Defina um percentual de desconto para pagamentos antes do vencimento.

Para mais informações, acesse: Juros, Multas e Desconto.

Instruções

Informação:

  • Efí Gateway permite o uso de no máximo 255 caracteres totais para serem inseridos como linha de instrução na impressão do boleto.
  • Permite no máximo 4 linhas.

Remova as aspas antes e depois das hashtags abaixo:

  • Instrução 1:
Após vencimento juros R$ #juro# ao dia.
  • Instrução 2:
Após vencimento multa R$ #multa#.

Aviso!

Caso adicione mais linhas, também deve inserir a variável de leitura da linha de instrução, nos parâmetros Imprimir instruções quando…

Para mais informações, acesse: Instruções da Carteira de Cobrança.

Impressão

  • Layout de impressão: Utilize o padrão 3 por página.

Para mais informações, acesse: Layouts de Impressão.

Fluxo de Funcionamento

sequenceDiagram
    participant S as Sistema
    participant Gateway as Gateway Efí
    participant W as Webhook

    S->>Gateway: Envia requisição (ex: gerar boleto)
    Gateway->>S: Responde com dados do boleto
    Note over Gateway,W: Evento ocorre (ex: pagamento)
    W->>S: Notifica sobre o evento
    S->>Gateway: Confirma recebimento da notificação

Tarefa de Consulta de Pagamentos

Dica:

Agora, além do webhook, também é possível configurar uma tarefa que consulta os pagamentos, que serve como uma garantia extra para que as confirmações de baixa de cobranças cheguem ao seu Sistema. Esta tarefa deve ser configurada para executar somente 1x no dia, recomendada na madrugada. Com isso, ela sempre irá consultar os pagamentos dos títulos que vencem no dia atual e anterior.
Para realizar a configuração, verifique em:

Ativação

Finalizado!

Com todos os passos concluídos, a carteira e as tarefas de consulta estão configuradas. Agora, um boleto teste pode ser gerado para efetuar o pagamento e validar a baixa automática da fatura no sistema.
Após a baixa ser processada corretamente, a homologação estará concluída.

Considerações Finais

A integração entre a Efí e o sistema representa um avanço significativo na otimização da gestão financeira para provedores de serviço.

Com automação de processos, redução de custos e suporte às demandas dos clientes, essa parceria reforça um caminho para operações financeiras mais ágeis, seguras e eficientes.

Etiquetas

IntegracaoBancaria GatewayBancario Efí Bolix BoletoHibrido GatewayDePagamento CarteiraDeCobranca

Leia Também

Visão de gráfico

Páginas relacionadas