Central de Ajuda

Leitura de 8 min

Efí Bank - Cartão de Crédito

Introdução

A integração entre o Sistema e a plataforma de pagamentos Efí tem como objetivo automatizar os processos financeiros e de vendas, oferecendo soluções completas e eficientes para pagamentos. Esta documentação apresenta os detalhes do processo de integração, seus benefícios e as configurações necessárias.

Parceria!

Caso ainda não possua uma conta na Efí, cadastre-se e aproveite um desconto exclusivo para clientes (Sistema), acessando:

Solução Oferecida

Meio de pagamento por cartão de crédito, tanto individual quanto recorrente.

Acesso ao Formulário

Caminho: Sistema > Cadastros > Financeiro > Carteira de cobrança.

Benefícios da Integração

BenefícioDescrição
AutomaçãoDiminui a necessidade de ações manuais e aumenta a eficiência
Flexibilidade de PagamentoAceita cartão de crédito tanto para pagamentos únicos quanto recorrentes
Receita PrevisívelAo ativar a recorrência, o fluxo de caixa se torna mais regular
Comodidade para o ClienteRedução de atrasos e interrupções no serviço por inadimplência

Estrutura

Como funciona a integração

  1. Configuração.
  2. Acesso à Central do Assinante.
  3. Escolha da Opção de Pagamento.
  4. Preenchimento dos dados do Cartão de Crédito.
  5. Habilitação da Recorrência.

Etapas de configuração do módulo

  • Configuração da integração com cartão de crédito.
  • Juros, multas e desconto.
  • Tarefa responsável pelo envio das cobranças recorrentes.

Campos obrigatórios

  • Descrição: nome dado ao cadastro da carteira de cobrança.
  • Conta: conta vinculada à carteira.
  • Tipo de recebimento: modalidade da integração que irá gerar as cobranças.
  • Validar filial na venda: se marcado como Sim, exige que a filial do contrato do cliente seja igual à filial da carteira.
  • Ativo: define se a carteira de cobrança está ativa ou inativa no Sistema.

Processo de Integração e Homologação

Para realizar a integração e homologação da Integração de Cartão de Crédito Efí no Sistema, siga os passos abaixo:

Homologação

Para prosseguir com a integração, é necessário abrir um atendimento com o setor Suporte Técnico, e ter em mãos os seguintes dados:

Dados Necessários

364 - Efí S.A (API Cartão de Crédito)

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

Dica!

Se tiver dúvidas sobre os dados bancários, consulte o(a) gerente de sua conta no banco.

Passo a passo para obter as credenciais da API

Informação!

Para homologar a Carteira de Cartão de Crédito Efí, é necessário gerar o “Client_ID” e “Client_Secret”, que são gerados dentro do Internet Banking do Efí.

  1. Acesse o Internet Banking Efí:
  2. Faça login com sua conta.
  3. No menu principal, selecione a opção API.
  4. No submenu, clique em Aplicações e depois no botão Criar Aplicação.
  5. Nomeie sua aplicação e clique em Continuar.
  6. Selecione o escopo API Cobranças e marque a opção Emissão de Cobranças.
  7. Em seguida, selecione o escopo API Pix e marque todas as opções, exceto “Consultar Saldo”.
  8. Após isso, role a tela até o final e clique em Continuar.
  9. Digite sua assinatura eletrônica e clique em Continuar.
  10. Com a aplicação criada, copie os dados das chaves Client_ID e Client_Secret que ficam na aba Produção e insira nos campos apropriados da carteira.
  11. O Identificador de conta está disponível na tela da aplicação, no menu lateral esquerdo, na opção Introdução.
  12. Copie o identificador e preencha-o no campo correspondente da carteira de cobrança no Sistema.

Após inserir as credenciais na carteira de cobrança no Sistema, salve as informações e faça um teste de liquidação com um título de cobrança via cartão. Se o teste for bem-sucedido, sua carteira estará pronta para uso.

Credenciais API Finalizadas!

Com os dados bancários informados, o atendente da (Sistema) dará continuidade no processo de homologação da sua carteira.

Criando a Carteira

  1. Acesse o menu Sistema.
  2. Abra a pasta Financeiro.
  3. Clique em Carteira de cobrança.
  4. Clique no botão Novo.

Aviso!

Antes de realizar qualquer configuração, vá até a aba Impressão e selecione no campo Layout de Impressão o modelo: Boleto + fatura detalhada.

Como essa integração não gera documento em papel, essa configuração garante que ao solicitar a impressão, uma fatura detalhada seja gerada.

  1. Na aba Carteira de cobrança, realize os seguintes ajustes:
    • Descrição: Nome da carteira que será cadastrada.
    • Conta: Crie a conta que armazenará os dados bancários.
    • Tipo de recebimento: Selecione a opção Cartão de crédito.
    • Enviar e-mail para cliente ao gerar: Marque como Não, pois exige que o cliente tenha um e-mail válido e faz o envio automático da fatura, o que não é recomendado neste caso.
    • Validar filial na venda: Marque como Não.
    • Ativo: Marque como Sim.
    • Filial: Remova clicando no X à direita do campo.
    • Planejamento analítico: Use o código 240 ou crie um novo conforme a necessidade.

Criando a Conta

  • Conta: Escolha um nome para a conta.
  • Tipo da Conta: Selecione a opção Banco.
  • Data de abertura: Data em que a conta está sendo criada.
  • Planejamento analítico: Mais informações em: Formulário Planejamento Analítico.
  • Filial: Escolha o ID da filial à qual a Conta e a Carteira estarão ligadas.

Na aba Banco:

  • Agência: Coloque o número da agência.
  • Dígito verificador da agência: Informe o dígito da agência.
  • Número da conta: Número da conta bancária.
  • Dígito verificador da conta: Informe o dígito da conta.

Configurações Cartão de Crédito

  • Gateway: Selecione Efí.
  • Ambiente gateway: Escolha Produção.
  • Habilitar recorrência: Marque como Sim para permitir que o cliente ative a cobrança automática via cartão pela central do assinante.
  • Gerencia identificador conta: Informação disponível na conta Efí.
  • Gerencia client ID: Informação disponível na conta Efí.
  • Gerencia client secret: Informação disponível na conta Efí.
  • URL callback gerencia: Clique no botão para gerar a URL de comunicação da integração com Efí.

Cuidado!

Acesse o Sistema pelo seu domínio para garantir que a URL use o endereço seguro (SSL) e não o IP. O uso do IP pode causar falhas na comunicação com a API.

Exemplo:

  • Máximo de parcelas: Defina como 1 se não desejar parcelamento, ou aumente conforme necessário.
  • Juro (% ao mês): Defina um percentual, válido somente se o número de parcelas for maior que 1.
  • Repassar taxa para o cliente: Marque “Sim” para incluir a taxa da transação no boleto ou “Não” para manter o valor original da fatura.

Redirecionar Taxas (Nova Função)

Melhoria!

O Sistema agora permite repassar a taxa de cartão ao cliente (válido para pagamentos únicos e recorrentes), o que está previsto por lei.

Se selecionar Repassar taxa para o cliente como “Sim”, novos campos aparecerão:

  • Será aplicada em pagamentos: Escolha entre Individuais, Recorrentes ou Ambos.
  • Porcentagem da taxa (%): Percentual que será adicionado à fatura.
  • Valor fixo da taxa (R$): Valor fixo em Reais acrescido ao pagamento com Cartão de Crédito.

Aviso!

Ao escolher Individuais, aplica-se somente aos pagamentos únicos feitos na Central do Assinante. Ao escolher Recorrentes, aplica-se apenas nas cobranças programadas. Com Ambos, aplica-se para as duas situações.

Juros/Multas/Desconto

  • Juros %: Valor sugerido de 0.033% (valor legal).
  • Multa %: Valor sugerido de 2% (valor legal).
  • Desconto até o vencimento R$: Valor fixo em Reais para pagamento antecipado.
  • Desconto até o vencimento %: Percentual de desconto para pagamento antecipado.

Mais informações: Juros, Multas e Desconto.

Dica!

Após todas as configurações, clique em Salvar para finalizar.

Ativando a Carteira de Cobrança no Sistema

Com a carteira criada, você pode ativá-la de duas formas:

  • Hotsite (Central do Assinante): Configure a carteira nos parâmetros gerais do Sistema para que todos os clientes tenham acesso a essa forma de pagamento.
  • Alternativa de Pagamento: Crie vínculos personalizados para disponibilizar essa carteira a grupos específicos de clientes.

Configurando a Carteira no Hotsite - Central do Assinante

  1. Vá ao menu Sistema.
  2. Clique em Hotsite.
  3. Acesse a pasta Configurações.
  4. Clique em Configurações Geral.
  5. Vá até a aba Financeiro.
  6. Defina os parâmetros de Cartão de Crédito e Recorrência com Cartão de Crédito.
  7. Clique em Salvar.

Dica!

Consulte o passo a passo completo no guia: Configurar Recorrência com Cartão de Crédito.

Configurando a Carteira como Alternativa de Pagamento

  1. Crie um cadastro de Alternativa de Pagamento de acordo com Configurações Alternativas de Pagamento.
  2. Acesse o menu Sistema > Cadastros > Financeiro > Carteira de cobrança e localize a carteira desejada.
  3. Clique em Editar.
  4. Em Configuração de alternativa de pagamento, informe o ID ou utilize a Lupa para buscar a alternativa criada.
  5. Clique em Salvar para finalizar.

Concluído!

Apenas contratos que usam essa carteira com a alternativa de cartão configurada poderão utilizar a forma de pagamento via cartão.

Tarefa de Baixa de Títulos em Recorrência

Para que os pagamentos recorrentes sejam efetivados, é necessário configurar uma tarefa no Sistema. Os pagamentos são enviados no dia do vencimento.

  1. Vá ao menu Ferramentas.
  2. Clique em Ferramentas.
  3. Acesse Agenda de tarefas.
  4. Clique em Novo.
  5. Tarefa: Escolha Baixar títulos cartão de crédito recorrente.
  6. Minuto (0-59): Informe o minuto de execução.
  7. Hora (0-23): Defina a hora de execução.

Dica!

Configure a tarefa para rodar apenas uma vez por dia, em horário que não coincida com outras tarefas.

Fluxos e Processos

Fluxo de Integração

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

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

Considerações Finais

A integração entre Efí e o Sistema representa uma grande melhoria, tornando os processos financeiros mais simples e automáticos. Com isso, é possível reduzir custos operacionais e oferecer um serviço mais eficiente para os clientes, contribuindo para um modelo de negócio mais sustentável.

Etiquetas

IntegracaoFinanceira Efi PagamentosOnline CartaoDeCredito APIEfi Recorrencia

Leia Também

Visão de gráfico

Páginas relacionadas