Central de Ajuda

Leitura de 7 min

Integração Bancária Gateway Efí Bank

Este documento fornece instruções detalhadas sobre como realizar a integração e utilizar o Gateway Efí, incluindo a configuração do Webhook para notificações em tempo real. O Gateway Efí oferece automação de processos bancários, enquanto o Webhook garante atualizações instantâneas sobre eventos financeiros.

Requisitos Importantes

  • Sistema Operacional Debian 10.
  • Para homologação de uma carteira Gateway, o recomendado é abrir um novo convênio de conta bancária. Caso opte por usar um que já esteja em uso no IXC e/ou que já emitiu boletos, esteja ciente de possíveis divergências em relatórios provenientes de arquivos de retorno.
    Essas divergências podem incluir: Título não encontrado no retorno, liquidações associadas a boletos incorretos, entre outros.

Objetivos Da Integração

  • Expandir as integrações disponíveis no Sistema.
  • Atender às solicitações de clientes que utilizam Efí e desejam compatibilidade com o Sistema.
  • Implementar geração de boletos híbridos (automática) e processar a baixa de pagamentos de forma integrada e eficaz.
  • Disponibilizar uma nova opção de integração, oferecendo maior flexibilidade de soluções financeiras para os clientes.

Benefícios Da Integração

1. Automação de Processos

  • Baixa automática de pagamentos: Garante mais agilidade, precisão e economiza tempo ao realizar as baixas automaticamente no Sistema.

2. Economia e Eficiência

  • Redução de custos: A Efí oferece tarifas competitivas, gerando economia para os clientes enquanto utilizam uma solução totalmente integrada.
  • Centralização de operações: Com o Gateway Efí, é possível gerenciar boletos e pagamentos em um único local, eliminando a necessidade de vários sistemas ou fornecedores.

3. Melhor Experiência Para O Cliente

  • Solicitação atendida: Integração que atende à demanda de clientes que já possuem contas na Efí.
  • Facilidade de adoção: Fácil de ser implementada, permitindo o uso imediato após a homologação.

4. Vantagem Competitiva

  • Maior atratividade do Sistema: A integração torna o Sistema mais interessante para novos clientes.
  • Retenção de clientes: Proporciona maior satisfação e fidelidade ao atender demandas específicas dos usuários.

Dica!

Ainda não possui uma Conta Efí? Acesse o link a seguir e obtenha um desconto especial por meio da nossa parceria:

Processo De Integração e Homologação

Homologação

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

364 - Efí (Gateway)

  • Número da agência com dígito.
  • Número da conta com dígito.
  • Client_ID.
  • Client_Secret.
  • Identificador da conta.

Dica!

Caso tenha dúvida sobre algum dos dados bancários, entre em contato com o gerente da 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 em API.
  4. Clique em Criar aplicação no menu de Introdução.
  5. Forneça um nome para sua aplicação, como Efí - IXC, e clique em Continuar.
  6. No menu de Escopos, submenu API Cobranças, habilite o recurso Emissão de cobranças.
  7. No submenu API Pix, habilite todas as caixas de Produção e Homologação, exceto as opções de Consultar Saldo.
  8. Clique em Continuar.
  9. Insira sua Assinatura Eletrônica Efí.
  10. Retorne ao menu Introdução e clique em Minhas Aplicações.
  11. Localize a aplicação criada e clique em Ações > Detalhar.
  12. Copie as Credenciais de API:
    • Chave Client ID.
    • Chave Client Secret.
  13. Para obter o Identificador da Conta, siga:
    • Clique em Introdução no menu API.
    • Clique no botão Identificador da Conta.
    • Uma janela com os dados será exibida; copie o código Identificador da Conta.
  14. Fim.

Atenção!

A criptografia do campo de Credencial/Token da API está presente na versão Beta do sistema. Sua disponibilidade na versão Estável será a partir de Outubro de 2025.


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.

Credenciais Finalizadas!

Após obter os dados, entre em contato com o suporte da IXC Soft para prosseguirem com a homologação da carteira Gateway.

Criando a Carteira

  1. No Sistema, acesse: Menu Sistema > Financeiro > Carteira de cobrança.
  2. Clique no botão Novo.
  3. Configure na aba Carteira de cobrança os seguintes campos:
    • Descrição: Nome da carteira.
    • Conta: Crie a conta que armazenará os dados bancários.
    • Tipo de recebimento: Selecione Gateway.
    • Enviar e-mail para cliente ao gerar: Defina como Não para evitar envios automáticos de faturas e alterações desnecessárias no registro.
    • Validar filial na venda: Marque como Sim.
    • Planejamento analítico: Utilize o padrão 240 ou cadastre um novo.
  4. Fim.

Configurações Gateway

  • Gateway: Escolha Efí.

  • Ambiente Gateway: Produção.

  • Client_ID e Client_Secret: use as credenciais obtidas anteriormente.

  • Call-back: gere a URL Call-back após salvar a carteira pela primeira vez.

  • Identificador da Conta: Insira o código copiado no menu API.

  • Gera pix: Marque como Sim, ser for utilizar o Pix no boleto.

Atenção, Beta!

O parâmetro Enviar cobrança Pix pelo WhatsApp está presente na versão Beta do Sistema. Sua disponibilidade na versão Estável será a partir de Julho de 2025.


  • Enviar cobrança Pix pelo WhatsApp: Ativa a funcionalidade de envio do Template Cobrança Pix, exclusivo da integração com o Opa! Suite. Habilitando este parâmetro, um novo campo ficará visível e obrigatório:
    • Tipo da chave Pix: Selecione na lista a opção que corresponde ao tipo da chave Pix que será utilizada (CPF/CNPJ, E-mail, Telefone ou Chave Aleatória).
    • Chave Pix: Insira a chave Pix principal que está configurada e é utilizada pela sua conta na instituição financeira correspondente a esta carteira de cobrança.

Atenção, Beta!

A funcionalidade Enviar Template Pix via WhatsApp com o Opa! Suite está presente na versão Beta do Sistema. Sua disponibilidade na versão Estável será a partir de Julho de 2025.


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.

Cuidado!

Se o domínio de hospedagem do Sistema mudar, edite a URL do Call-back e solicite o ajuste no suporte da Efí.

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 os dados
    Note over Gateway,W: Evento ocorre (ex: pagamento)
    W->>S: Notifica o evento no Sistema
    S->>Gateway: Confirma o recebimento da notificação

Novidade!

Melhoria no processamento de logs de liquidação no Sistema.

  • Antes, ao receber um log de pagamento, este permanecia pendente/aguardando por até 3 horas para ser processado, dependendo de uma tarefa executada a nível de servidor.
  • Agora, os logs do Gateway Efí são processados imediatamente após sua chegada ao Sistema, como ocorre com os Gateways Lytex, Asaas e Banco do Brasil, por exemplo.

Considerações Finais

A integração Efí e Sistema é um avanço na gestão financeira, oferecendo automação, redução de custos e soluções solicitadas pelos clientes. Essa parceria aumenta a eficiência e proporciona um ambiente de negócios simplificado, promovendo confiança e praticidade.

Etiquetas

IntegracaoBancaria GatewayBancario Efí Bolix BoletoHibrido GatewayDePagamento CarteiraDeCobranca

Leia Também

Explore nossos produtos!

IXC ACS
Opa! Suite
IXC ONER
Olli

Páginas relacionadas