Ir para o conteúdo

Módulo Efí Pix para WHMCS

versão downloads abrir issue

Receba por Pix instantaneamente, direto na sua conta Efí, as cobranças do WHMCS. O QR code e o copia e cola aparecem na própria fatura, e a confirmação do pagamento é automática, em tempo real. Desenvolvido pela Gofas Software, é 100% gratuito.

Sumário

Download

Baixar a versão mais recente

Funcionalidades

  • Confirmação automática em tempo real do pagamento e baixa da fatura
  • QR code na fatura do WHMCS, sem redirecionamentos
  • Copia e cola do código Pix em um clique
  • Reemissão automática do QR code expirado
  • Chave Pix definida pelo administrador do WHMCS
  • Mensagem personalizada exibida na fatura
  • Valor mínimo da fatura para permitir pagamento via Pix
  • Cálculo da tarifa por transação confirmada, preenchendo o campo "Taxas" (fee) da lista de transações do WHMCS
  • Dispensa configuração de campos CPF/CNPJ: o módulo detecta automaticamente os campos personalizados de clientes
  • Suporte a produção e a testes (sandbox)
  • Logs de diagnóstico configuráveis
  • Aviso de atualização e verificação de versão na própria tela de configuração do módulo

Requisitos

  • WHMCS >= 8.0
  • PHP >= 7.1
  • Conta Efí (Efí Pay) com Pix habilitado
  • Credenciais: Client ID e Client Secret (produção e homologação)
  • Certificado .p12 convertido para .pem (produção e homologação)
  • Chave Pix aleatória cadastrada na conta Efí

Instalação

  1. Baixe o arquivo pelo link de download e descompacte. Será criada a pasta gofasefipix.
  2. Copie a pasta modules de dentro de gofasefipix para a raiz da instalação do WHMCS, mesclando com as pastas existentes.
  3. Ative o módulo em Opções > Pagamentos > Portais para Pagamentos > aba All Payment Gateways.
  4. Informe as credenciais, os certificados e a chave Pix.

Configuração

Pré configuração na Efí

  1. Em API > Aplicações, crie uma aplicação e copie as credenciais Client ID e Client Secret geradas para produção e para homologação.
  2. Em API > Meus certificados, gere um certificado para produção e outro para homologação.
  3. Converta os certificados para o formato PEM (certificado e chave em um único arquivo):
openssl pkcs12 -in certificado.p12 -out certificado.pem -nodes -password pass:""
  1. Em Pix > Minhas chaves, cadastre uma chave aleatória para usar na configuração do módulo.

Pré configuração no WHMCS

Crie um campo personalizado de cliente para CPF e/ou CNPJ, ou dois campos distintos, um para cada documento. O módulo identifica os campos automaticamente. O CPF é obrigatório mesmo quando o cliente tem CNPJ no cadastro.

Opções do módulo

Tela de configuracoes do modulo

  • Chave Client ID Produção e Chave Client Secret Produção: credenciais da aplicação em modo produção.
  • Certificado Produção: caminho completo do arquivo .pem de produção, exemplo /var/www/site.com.br/certificado.pem.
  • Chave Client ID Desenvolvimento e Chave Client Secret Desenvolvimento: credenciais da aplicação em modo homologação.
  • Certificado Homologação: caminho completo do arquivo .pem de homologação.
  • Chave Pix: chave Pix aleatória registrada na sua conta Efí.
  • Sandbox: gera cobranças em modo de teste.
  • Salvar Logs: grava informações de diagnóstico em Utilitários > Logs > Log de Módulo.
  • Valor mínimo: valor mínimo da fatura para permitir pagamento via Pix. Formato decimal separado por ponto, exemplo 2.99.
  • Valor da tarifa Efí: percentual da comissão paga à Efí a cada transação confirmada, usado para preencher o campo "Taxas" (fee) da transação no WHMCS.
  • Mensagem na fatura: texto exibido na fatura, acima do botão de visualizar o Pix.
  • Enviar estatísticas de uso (opcional): controla o envio identificado das estatísticas de confirmação de pagamento. Desmarcado, as confirmações continuam sendo contabilizadas de forma anônima.

Informações importantes

  • A tarifa do Pix é paga separadamente à Efí, conforme o plano da sua conta.
  • O certificado precisa estar em formato PEM e acessível pelo PHP no servidor. Mantenha o arquivo fora da raiz pública do site.
  • Sempre faça backup antes de mudar algo no seu sistema.

Suporte

Abrir issue no fórum do módulo.

Licença

O código deste módulo é público para transparência e auditoria. Isso não transfere a titularidade nem concede licença livre de uso: o software é de propriedade da Gofas Software, protegido pela Lei 9.609/98 e pelos tratados de direitos autorais.

Trechos do contrato de licença de uso que se aplicam diretamente a este repositório:

  • Não redistribuir: é proibido o aluguel, o arrendamento, o empréstimo, a cessão e o licenciamento do software a terceiros, total ou parcial, assim como o fornecimento de serviços de hospedagem comercial do software (Cláusula 10ª, §3º).
  • Não modificar: é vedado qualquer procedimento que implique engenharia reversa, descompilação, desmontagem, tradução, adaptação ou modificação do software, bem como qualquer alteração não autorizada de suas funcionalidades (Cláusula 10ª, §2º).
  • Módulo alterado perde o suporte: a Gofas não se responsabiliza por defeitos decorrentes de alteração do software, de operação por pessoas não autorizadas ou da integração com softwares de terceiros (Cláusula 10ª, §7º). O suporte é uma cortesia e não é garantido pela licença (Cláusula 7ª, §1º).

Changelog

Melhorias:

  • readme: link de suporte para o forum do proprio modulo - #14
  • readme: contador do site, captura sem aviso de hook e secao de licenca - #13
  • readme: captura versionada, badges e sumario - #12
  • readme: conteudo da pagina do site transferido e captura de configuracao - #11

Comparar versões

Melhorias:

  • Telemetria com consentimento (v1.3.0) - #10
  • Adicionar consentimento e padronizar telemetria - #9
  • Migrar repo para org gofas - #8
  • Sincronizar pagamentos diretos Efí com WHMCS (criar clientes se necessário) - #7 enhancement

Comparar versões

Melhorias:

  • Compatibilidade com PHP 8.2 e 8.3 - #5

Comparar versões

Melhorias:

  • Melhorada a logica de formação dos URLs para impedir barras duplicadas - #4

Comparar versões

Melhorias:

  • Cobranças agora são geradas com CPF e CNPJ dando prioridade para CNPJ - #3 enhancement

Comparar versões

Melhorias:

Correções:

  • Reduz a descrição para no máximo 140 caracteres - #2 bug

Comparar versões

Melhorias:

Comparar versões

Deixe um Comentário

Você precisa fazer login para publicar um comentário.

Role para cima