Módulo Efí Pix para WHMCS
Funcionalidades
✓ Confirmação automática em tempo real
✓ QR code diretamente na fatura do WHMCS
✓ Copiar código QR com apenas um clique
✓ Tarifa especial para usuários do módulo
✓ Mensagem personalizada na fatura
✓ Reemissão automática de QR code expirado
✓ Chave Pix definida pelo administrador do WHMCS
✓ Instalação fácil e configuração intuitiva
Tarifa promocional
0.99% / pagamento confirmado (limite R$ 7,90)
Para usuários do módulo e novos clientes que realizarem cadastro neste endereço.
Requisitos do sistema
- WHMCS versão 8.0 ou superior;
- PHP 7.1 ou superior;
- Ioncube Loader 12.0 ou superior.
Instalação
Ao descompactar o arquivo do download, observe que os diretórios foram distribuídos seguindo a mesma hierarquia dos diretórios padrão do WHMCS, o arquivo + pasta do módulo Gateway está localizado no diretório /modules/gateways/. Siga os passos a seguir se precisar de mais detalhes:
Configuração na Efí
Acesse
API > Aplicações, crie uma aplicação (caso ainda não exista ou deseje utilizar uma aplicação diferente das existentes) e copie as credenciais Chave Client ID e Chave Client Secret geradas para o modo Produção e Homologação. Essas informações serão utilizadas a seguir nas configurações do módulo;:
https://app.sejaefi.com.br/api/aplicacoes/- Acesse
API > Meus certificadosgere um certificado para Produção e outro para Homologação:
https://app.sejaefi.com.br/api/meus-certificados - Baixe os certificados e converta-os para o formato PEM executando o seguinte comando no terminal (gera certificado e chave em único arquivo):
openssl pkcs12 -in certificado.p12 -out certificado.pem -nodes -password pass:"" - Acesse
Pix > Minhas chaves, cadastre uma chave aleatória e salve para inserir nas configurações do módulo a seguir.
https://app.sejaefi.com.br/pix/minhas-chaves
Configuração no WHMCS
Campos personalizados e ativação
- Se ainda não existir, crie um campo personalizado de cliente para CPF e/ou CNPJ, ou se preferir, crie dois campos distintos, um campo apenas para CPF e outro campo para CNPJ. O módulo identifica os campos do perfil do cliente automaticamente. CPF é obrigatório mesmo quando o cliente possui CNPJ no cadastro;
- Acesse Apps & Integrations > Pesquise "Efí Pix" (Efí com assento agudo no í ) > Clique em "Activate";
Configurações do módulo
- Chave Client ID Produção* (Obrigatório):
- Chave Client Secret Produção* (Obrigatório):
- Certificado Produção*: (Obrigatório). Caminho completo e nome do arquivo, exemplo: /var/www/site.com.br/certificado.pem
- Chave Client ID Desenvolvimento*: (Obrigatório)
- Chave Client Secret Desenvolvimento* (Obrigatório)
- Certificado Homologação* (Obrigatório). Caminho completo e nome do arquivo, exemplo: /var/www/site.com.br/certificado.pem
- Chave Pix* (Obrigatório): Chave Pix aleatória registrada na sua conta Efí (gerenciar chaves)
Veja aqui como criar suas chaves de API (API Tokens) via painel Efí - Sandbox: Ative essa opção para gerar cobranças em modo de teste.
- Salvar Logs: Salva informações de diagnóstico em Utilitários > Logs > Log de Módulo. Para funcionar, antes é necessário ativar o debug de módulo clicando em "Ativar Log de Debug";
- Valor mínimo: Insira o valor total mínimo da fatura para permitir pagamento via Pix. Formato: Decimal, separado por ponto. Exemplo: 2.99;
- Valor da tarifa Efí: (Opcional) Insira o valor percentual da comissão paga à Efí a cada transação via Pix com pagamento confirmado. Essa informação servirá para calcular e preencher o campo "Taxas" (fee) da lista de transações do WHMCS, já que a API Efí não retorna essa informação. Use ponto(.) para separar casas decimais, ex.: 1.5. Caso não preenchido esse campo a tarifa promocional para clientes Gofas Software será aplicada;
- Mensagem na fatura: Texto exibido na fatura acima do botão "Vizualizar Pix";
Utilize também os módulos de integração Efí Bank para Boleto Bancário e Cartão de Crédito e simplifique a gestão do seu negócio administrando todos os recebimentos em um único painel de controle, sem abrir mão das melhores tarifas do mercado para ter as melhores funcionalidades.
Histórico de atualizações
v1.2.0 (03/03/2025)
Closed issues:
- Compatibilidade com PHP 8.2 e 8.3 #5
v1.1.1 (02/12/2024)
Closed issues:
- Melhorada a logica de formação dos URLs para impedir barras duplicadas #4
v1.1.0 (16/09/2024)
Implemented enhancements:
- Cobranças agora são geradas com CPF e CNPJ dando prioridade para CNPJ #3
v1.0.1 (11/04/2024)
Fixed bugs:
- Reduz a descrição para no máximo 140 caracteres #2
v1.0.0 (28/02/2024)
Implemented enhancements:
- Lançamento 🎉 #1
* This Changelog was automatically generated by github_changelog_generator