Pular para o conteúdo principal

Magento 2

Módulo Oficial da Efí para o Magento 2 - Versão 1.0.0


O módulo Efí para Magento 2 permite receber pagamentos por meio do checkout transparente através da nossa API. Com ele, o proprietário da loja pode optar por receber pagamentos via boleto Bancário, Cartão de crédito, Open Finance e/ou Pix .


1. Requisitos

  • Versões do Magento 2 compatíveis: 2.4.4, 2.4.5 e 2.4.6
  • Versão mínima do PHP: 8.1.x

2. Instalação do Módulo

Realize o download do módulo e siga os seguintes passos de acordo com a forma que sua loja foi instalada:

Instalar usando o Composer

  • Instale via packagist
    • composer require gerencianet/module-magento2
Atenção!

Neste momento, podem ser solicitadas suas credenciais de autenticação do Magento. Caso tenha alguma dúvida, há uma descrição de como proceder neste link da documentação oficial.


  1. Execute os comandos:
  • bin/magento setup:upgrade
  • bin/magento setup:di:compile
  • bin/magento cache:clean
  • bin/magento setup:static-content:deploy -f
  • bin/magento cache:flush

Instalar usando o Github

Realize o download do módulo: Clicando aqui!

  1. Extraia o conteúdo do download ZIP e mova o diretório \Magento2 para dentro da pasta Gerencianet;

  2. Verifique se está dessa maneira seus diretórios na sua loja app/code/Gerencianet/Magento2

  3. Habilite o módulo com o seguinte comando, bin/magento module:enable Gerencianet_Magento2

  4. Instale a SDK PHP da Efí utilizando o seguinte comando composer require gerencianet/gerencianet-sdk-php:5

  5. Execute o comando: bin/magento setup:upgrade

  6. Execute o comando: bin/magento setup:di:compile

  7. Execute o comando: bin/magento cache:clean


3. Configurações

Acesse no Painel Administrativo do Magento no menu lateral clique em Lojas > Configuração > Clientes > Configurações de Cliente > Opções de Nome e Endereço. Em Número de Linhas em Endereço você deve informar o número 4 , conforme imagem abaixo:

banner

Configurações do endereço

OBS: No cadastro do usuário, preencher os campos do endereço com rua, número, bairro e complemento, respectivamente.

Certifique-se também que o campo de telefone esteja obrigatório.

Após realizar a configuração do Cliente, acesse no Painel Administrativo do Magento no menu lateral clique em Lojas, na sequencia clique em Configuração, no sub-menu Vendas clique em Formas de Pagamento. Será carregada a tela para configurar os meios de pagamentos do site.

banner

Configurações do Módulo


3. Como habilitar o Módulo da Efí

No primeiro bloco de informação, está a configuração para habilitar ou desabilitar o módulo por completo, marque Sim para continuar a configuração.

banner

Configurações do Módulo

Campos:

  • Ambiente: Serve para descrever se as transações serão realizadas em ambiente de produção e homologação.
  • Validação de mTLS: se habilitado, validaremos o mTLS
  • Identificador de conta: Identificador de conta da Efí
  • Novo Order Status: Serve para após a finalização da compra definir o Status do pedido.
  • Credenciais de Desenvolvimento ou Produção: Aqui você informa as suas credenciais (Client Id e Client Secret do ambiente selecionado).

Em seguida temos as configurações de cartão de crédito, configurações de boleto, configurações de pix e configurações de Open Finance.

OBS: Para que todas as configurações a seguir funcionem, todo o passo a passo anterior deve ter sido seguido.

Boleto

Nesta sessão você tem as configurações de boleto.

banner

Configurações do Boleto

Campos:

  • Habilitado: Serve para habilitar ou desabilitar a funcionalidade do boleto.
  • Título: Altera o nome do método de pagamento no checkout.
  • Dias de validade do Boleto: Validade do Boleto.
  • Multa após o vencimento: Valor da multa a ser cobrada após o vencimento.
  • Juros após o vencimento: Valor de juros a ser cobrado.
  • Instruções no boleto: Aqui você tem quatro campos que podem ser preenchido com mensagens no boleto, desde que as opções de juros e multa estejam zeradas.

Cartão de Crédito

Nesta sessão você tem as configurações de cartão de crédito.

banner

Configurações do Cartão

Campos:

Habilitado: Serve para habilitar ou desabilitar a funcionalidade de cartão de crédito. Título: Altera o nome do método de pagamento no checkout. Sort Order: Ordenação do método de pagamento.

Atenção!

Toda configuração de parcelamento, é realizada através do painel da Efí.


Pix

Nesta sessão você tem as configurações de Pix.

banner

Configurações do Pix

Campos:

  • Habilitado: Serve para habilitar ou desabilitar a funcionalidade do PIX.
  • Título: Altera o nome do método de pagamento no checkout.
  • Dias de validade do Pix: Tempo de validade do PIX (em segundos).
  • Certificado Pix: Certificado gerado no painel da Efí
  • Chave Pix: Sua chave pix cadastrada na Efí
Chave Pix

Caso a sua chave Pix esteja cadastrada como número de telefone, não se esqueça de seguir o padrão definido pelo BACEN informando +55 DDD e o número, exemplo: +5531988887777


Open Finance

Nesta sessão você tem as configurações do Open Finance.

banner

Configurações do Open Finance

Campos:

  • Habilitado: Serve para habilitar ou desabilitar a funcionalidade do Open Finance
  • Título: Altera o nome do método de pagamento no checkout
  • Certificado Open Finance: Certificado gerado no painel da Efí
  • Nome: Nome do titular da conta
  • CPF/CNPJ: Documento do titular da conta
  • Número da Conta: Número da conta Efí

4. Dúvidas Frequentes

É obrigatório possuir SSL em minha loja para aceitar pagamentos com o módulo?

Para que o módulo da Efí para Magento funcione, não é necessário que a loja possua um certificado SSL. Contudo é extremamente recomendado pela Efí que os lojistas utilizem. Independente da sua utilização, todos os dados de pagamento são criptografados e transmitidos com segurança para validação do pagamento. A presença de um certificado SSL instalado em sua loja garante maior segurança para o lojista e para os clientes que realizam compras. A ausência do certificado SSL na tela de pagamento, pode fazer com que o lojista perca vendas, uma vez que o cliente pode se sentir inseguro para digitar dados de pagamento em uma página que não possui um certificado.


Quero usar o Checkout Transparente de forma que o cliente não saia da minha loja para realizar o pagamento. É possível?

Sim. O módulo da Efí para Magento utiliza o checkout transparente para realizar o pagamento dos clientes, ou seja, em nenhum momento o cliente irá sair da sua loja virtual para finalizar o pagamento. Assim, no último passo da compra, será solicitado ao clientes dos dados obrigatórios para efetivar o pagamento.


As parcelas das opções de pagamento não estão sendo carregadas. Como corrigir?

Se após a instalação e configuração do módulo as parcelas do cartão de crédito não carregarem ao clicar sobre as bandeiras dos cartões, o lojista deverá verificar as credenciais informadas na configuração do módulo (chaves Client_Id, Client_Secret e também o "identificador de conta"). Se estiverem corretas, entre em contato com a Efí para que o problema seja analisado.


Estou recebendo a mensagem “Unauthorized” ao tentar finalizar uma compra. O que fazer?

Essa mensagem de erro pode estar relacionada com a as credenciais informadas de forma incorreta. Verifique se as suas credenciais estão corretamente inseridas nos respectivos campos de PRODUÇÃO e DESENVOLVIMENTO. Confira em nossa FAQ informações detalhadas.


Está aparecendo a mensagem “ATENÇÃO! Essa loja está em Modo Desenvolvimento. Um boleto de teste será gerado no ambiente de Sandbox da Efí”. Como corrigir?

Esta mensagem irá ser exibida quando seu módulo estiver configurado em ambiente de testes (sandbox). Para remover esta mensagem e começar a receber com a Efí, acesse as configurações do módulo em Sistema > Configuração > Formas de Pagamento > Efí Transparente e altere a opção Ambiente de Desenvolvimento para Produção.


Onde posso acompanhar as transações geradas pelo módulo?

As transações geradas através do módulo podem ser acompanhadas em sua conta Efí no link API > Minhas Aplicações > Sua Aplicação. Através das abas "Produção" e "Desenvolvimento" você poderá acompanhar todas as transações e suas respectivas situações, de acordo com o ambiente que estiver utilizando.


Quando tempo realizar um pagamento recebo a mensagem “Ocorreu um erro ao tentar realizar a sua requisição. Entre em contato com o proprietário da loja.”

Essa mensagem de erro pode ser exibida no momento da finalização da compra por diversos fatores. Neste caso, o primeiro passo é verificar as credenciais da sua aplicação e também conferir em sua API a sub-aba "histórico de requisições" veja como usar este recurso.


5. Suporte e Sugestões

Sua sugestão de novas ideias e implementações para o módulo da Efí para Magento é muito importante. Portanto, caso você tenha alguma ideia, entre em contato com a nossa equipe. Iremos analisar sua sugestão e avaliar a possibilidade de implantação.

Caso você tenha alguma dúvida, entre em contato conosco pelo site Efí.