Pular para o conteúdo principal

OpenCart

Módulo de Integração Efí para OpenCart


O módulo Efí para OpenCart permite receber pagamentos por meio do checkout transparente da nossa API. Este módulo é o Módulo Oficial da Efí para o OpenCart, compatível apenas com as versões do OpenCart igual ou superior a versão 4.1.0.1.

Você pode baixar o OpenCart aqui.

1. Requisitos do sistema​

Utilizando PHP 8.1​

  • Versão do MySQL: 5.7 ou superior.

Instalação de dependências que podem estar faltando: 

sudo apt-get install php8.1-dom  
sudo apt-get install php8.1-curl  
sudo apt-get install php8.1-gd  
sudo apt-get install php8.1-xml  
sudo apt-get install php8.1-zip
  • OpenCart necessita do curl ativado
Importante!

Os requisitos do sistema foram definidos de acordo com os nossos testes. Se seu sistema não se encaixa nos requisitos, não significa que o módulo disponibilizado não funcionará em seu OpenCart, mas sim, que não testamos no mesmo ambiente.

Portanto, não garantimos o funcionamento deste módulo em ambientes diferentes dos citados acima.


2. Instalação​

O módulo da Efí para OpenCart deve ser instalado exclusivamente pelo instalador do próprio OpenCart.:

  • Instalação Automática: utilizando o arquivo de instalação do módulo compactado através da ferramenta de adicionar nova extensão do OpenCart;

Instalação Automática​

  1. Faça o download do arquivo efi.ocmod.zip.

  2. Acesse o menu Extensions > Installer (Extensões > Instalador), clique no botão Upload, selecione o arquivo 'efi.ocmod.zip' (citado na primeira instrução) e aguarde a conclusão da instalação automática.

Nota

Caso você já tenha instalado o módulo da Efí anteriormente, o OpenCart poderá informar que alguns arquivos serão sobrescritos. Não se preocupe, pois a instalação não afetará qualquer arquivo que não seja do módulo da Efí já existente em sua loja.


Atenção!

Devido ao tamanho do arquivo de instalação do módulo, talvez seja necessário alterar o parâmetro php_max_upload do php.ini para, no mínimo, 3 mb.


3. Configurações​

Acesse Extensions > Modifications (Extensões > Modificações), selecione o módulo Efí e clique no botão Refresh (Atualizar) no canto superior direito da página.

Ao acessar Extensions > Extensions (Extensões > Extensões), você deverá selecionar o tipo de extensão que deseja. Escolha Payments (Pagamentos). Você já visualizará o módulo da Efí disponível na lista. Clique em install (instalar) para instalar o módulo e depois em edit (editar) para iniciar a configuração.

Cinco abas estarão disponíveis para realizar a configuração do módulo:

  • Configurações gerais
  • Pix
  • Boleto
  • Open Finance
  • Cartão de Crédito

Configurações Gerais​

banner

Configurações Gerais

Nesta aba é necessário informar:

  • As credenciais de Produção e Desenvolvimento da sua aplicação (obtidas na sua conta Efí)
  • O identificador de conta (obtido na sua conta Efí)
  • Ordem de Exibição: Define a ordem que o plugin deve aparecer ao ser listado como método de pagamento
  • Status do pedido: Define qual status os pedidos devem assumir ao serem pagos
  • Ativar ambiente de teste: Determina se o módulo está em modo de testes. No modo de teste você pode gerar cobranças fictícias para testar o fluxo.
  • Ativar Plugin: Determina se o módulo de pagamentos da Efí está Ativo ou Inativo.

Pix​

banner

Configurações do Pix

Nesta aba, as seguintes propriedades podem ser configuradas:

  • Chave Pix: Define para qual chave Pix o valor do pagamento será direcionado. É obrigatório que essa chave esteja cadastrada na sua conta Efí.
  • Tempo de expiração da cobrança: Determina o tempo de validade do QR Code Gerado, em horas.
  • Certificado: Faça o upload do seu certificado digital no formato .p12, obrigatório para a autenticação com a API do Efí.
  • Desconto: Você pode fornecer desconto para clientes que pagam por meio do Pix.
  • Validar mTLS: Habilita ou desabilita a verificação de segurança utilizando mTLS. Mais informações você encontra aqui.
  • Ativar: Habilita ou desabilita o Pix como forma de pagamento disponível na loja.
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


Boleto​

banner

Configurações do Boleto

Nesta aba, as seguintes propriedades podem ser configuradas:

  • Dias para vencimento do boleto: Determina a quantidade de dias para o vencimento do boleto, a contar da data de sua geração.
  • Desconto: Determina a quantidade de desconto que será aplicado no boleto.
  • Configuração de multa: Configuração de multa para ser aplicada automaticamente no caso de pagamento após o vencimento do boleto.
  • Configuração de juros: Configuração de jutos para ser aplicado automaticamente no caso de pagamento após o vencimento do boleto.
  • Mensagem no boleto: Permite incluir uma mensagem no boleto para o cliente final.
  • Enviar e-mail para o cliente final: Caso selecionado, serão enviados e-mails sobre as transações para o cliente final.
  • Ativar: Habilita ou desabilita o Boleto como forma de pagamento disponível na loja.

Open Finance​

banner

Configurações do Open Finance

Nesta aba, as seguintes propriedades podem ser configuradas:

  • Chave Pix para recebimento: Preencha com a chave Pix que receberá os pagamentos Open Finance.
  • Desconto: Determina a quantidade de desconto que será aplicado nos pagamentos via Open Finance.
  • Certificado: Faça o upload do seu certificado digital no formato .p12, obrigatório para a autenticação com a API do Efí.
  • Ativar: Habilita ou desabilita o Open Finance como forma de pagamento disponível na loja.

Cartão de crédito​

banner

Configurações do Cartão

Nesta aba, a seguinte propriedade pode ser configurada:

  • Ativar: Habilita ou desabilita o Cartão de Crédito como forma de pagamento disponível na loja.

5. 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 OpenCart funcione corretamente, é obrigatório que a loja possua um certificado SSL instalado. Além de ser um requisito técnico, o SSL garante a criptografia dos dados durante a comunicação com o gateway de pagamento, aumentando a segurança tanto para o lojista quanto para os clientes. A ausência de SSL na tela de pagamento pode gerar desconfiança e impactar negativamente nas conversões, já que muitos clientes evitam inserir dados sensíveis em páginas não seguras. Mesmo com a criptografia já aplicada nas requisições, o uso de SSL na loja é indispensável para o funcionamento completo e seguro do módulo.


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 OpenCart 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 “Efí Desabilitada: O modo Sandbox (Ambiente de testes) está ativo. Suas cobranças não serão validadas”. 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 Extensions > Payments > Efí > Editar (ou em Extensões > Pagamentos > Efí > Editar) e desmarque a opção SandBox > Habilitar Sandbox Efí (Ambiente de testes).


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. Neste ambiente você poderá acompanhar todas as transações e suas respectivas situações.


Quando tento 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.


8. Suporte e Sugestões​

Sua sugestão de novas ideias e implementações para o módulo da Efí para OpenCart é 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í.

Última atualização em