Módulo Efí para WHMCS

Instalação

1. Faça o download da última versão do módulo;
2. Descompacte o arquivo baixado;
3. Copie o arquivo efi.php e a pasta efi, para o diretório /modules/gateways da instalação do WHMCS;
4. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 modules/gateways/efi.php
5. Altere as permissões da pasta copiada utilizando o comando: chmod 777 modules/gateways/efi/ -R
6. Copie o arquivo efi.php e a pasta efi, disponível no diretório callback, para o diretório modules/gateways/callback.
7. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 modules/gateways/callback/efi.php
8. Altere as permissões da pasta copiada utilizando o comando:: chmod 777 modules/gateways/callback/efi -R
9. Copie o arquivo efi.php, disponível no diretório hooks, para o diretório includes/hooks. Ele deve estar no caminho includes/hooks/efi.php
10. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 includes/hooks/efi.php
11. Crie uma pasta na raiz do seu servidor e insira seu certificado na pasta.

Ao final da instalação, os arquivos do módulo Efí devem estar na seguinte estrutura no WHMCS:

includes/hooks/
  |- efi.php
 modules/gateways/
  |- callback/efi/
  |- callback/efi.php
  |- efi/
  |- efi.php

Certificado para utilização da API PIX

Todas as requisições devem conter um certificado de segurança que será fornecido pela Efí dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na integra no manual de segurança do PIX(https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados).

Caso ainda não tenha seu certificado, basta seguir o passo a passo do link a seguir para gerar um novo: https://gerencianet.com.br/artigo/como-gerar-o-certificado-para-usar-a-api-pix/

Configuração do Módulo

1. Client_Id Produção: Deve ser preenchido com o client_id de produção de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações";
2. Client_Secret Produção: Deve ser preenchido com o client_secret de produção de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações";
3. Client_Id Desenvolvimento: Deve ser preenchido com o client_id de desenvolvimento de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações";
4. Client_Secret Desenvolvimento: Deve ser preenchido com o client_secret de desenvolvimento de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações";
5. Identificador da conta: Deve ser preenchido com o identificador da sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Introdução"->"Identificador da Conta";
6. Usuário administrador do WHMCS: Deve ser preenchido com o usuário administrador do WHMCS. É necessário utilizar o mesmo usuário que o administrador do WHMCS utiliza para fazer login na área administrativa de sua conta. Este campo é de preenchimento obrigatório;
7. Desconto do Boleto: Informe o valor desconto que deverá ser aplicado aos boletos gerados exclusivamente pela Efí. Esta informação é opcional;
8. Tipo de desconto: Informe o tipo de desconto (porcentagem ou valor fixo) que deverá ser aplicado aos boletos gerados exclusivamente pela Efí. Esta informação é opcional;
9. Número de dias para o vencimento do Boleto: Informe o número de dias corridos para o vencimento do boleto Efí após a cobrança ser gerada. Se o campo estiver vazio, o valor será 0;
10. E-mail de cobrança - Efí: Caso seja de seu interesse, habilite o envio de emails de cobrança da Efí para o cliente final;
11. Configuração de Multa: Caso seja de seu interesse, informe o valor, em porcentagem, cobrado de multa após o vencimento. Por exemplo: se você quiser 2%, você deve informar 2. Mínimo de 0.01 e máximo de 10. Integer;
12. Configuração de Juros: valor cobrado de juros por dia após a data de vencimento. Por exemplo: se você quiser 0,033%, você deve informar 0.033. Mínimo de 0.001 e máximo de 0.33;
13. Observação: Permite incluir no boleto uma mensagem para o cliente;
14. Sandbox: Caso seja de seu interesse, habilite o ambiente de testes da API Efí;
15. Debug: Neste campo é possível habilitar os logs de transação e de erros da Efí no painel WHMCS;
16. Chave PIX: Se utilizado CNPJ, informar sem pontos e espaços, ex. 11111111111121;
17. Certificado Pix: Deve ser preenchido com o caminho do certificado salvo em seu servidor no passo 10 da instalação;
18. Desconto: Informe o valor de desconto que deverá ser aplicado ao pix gerado exclusivamente pela Efí;
19. Validade da Cobrança PIX: Deve ser informado o período de validade em dias da cobrança PIX;
20. Nome: Deve ser informado o nome do titular da conta;
21. Documento: Deve ser informado o documento (CPF ou CNPJ) do titular da conta;
22. Agência: Deve ser informado a agência do titular;
23. Conta : Deve ser informado o número referente a conta;
24. Tipo de conta: Deve ser informado o tipo de conta referente ao titular ;
25. Validar mTLS: Entenda os riscos de não configurar o mTLS acessando o link https://gnetbr.com/rke4baDVyd;
26. PIX: Selecione essa opção caso deseje deixar a opção PIX como forma de pagamento;
27. Boleto: Selecione essa opção caso deseje deixar a opção boleto como forma de pagamento;
28. Cartão de Crédito: Selecione essa opção caso deseje deixar a opção de cartão de crédito como forma de pagamento;
29. Open Finance: Selecione essa opção caso deseje deixar a opção de open finance como forma de pagamento.

English Translation

Efí Module for WHMCS

Installation

1. Download the latest version of the module.
2. Unzip the downloaded file.
3. Copy the efi.php file and the efi folder to the /modules/gateways directory of your WHMCS installation.
4. Change the permissions of the copied file using the command: chmod 777 modules/gateways/efi.php
5. Change the permissions of the copied folder using the command: chmod 777 modules/gateways/efi/ -R
6. Copy the efi.php file and the efi folder, available in the callback directory, to the modules/gateways/callback directory.
7. Change the permissions of the copied file using the command: chmod 777 modules/gateways/callback/efi.php
8. Change the permissions of the copied folder using the command: chmod 777 modules/gateways/callback/efi -R
9. Copy the efi.php file, available in the hooks directory, to the includes/hooks directory. It should be located at includes/hooks/efi.php.
10. Change the permissions of the copied file using the command: chmod 777 includes/hooks/efi.php
11. Create a folder in the root of your server and place your certificate in the folder.

At the end of the installation, the Efí module files should have the following structure in WHMCS:

includes/hooks/
  |- efi.php
 modules/gateways/
  |- callback/efi/
  |- callback/efi.php
  |- efi/
  |- efi.php

Certificate for using the PIX API

All requests must contain a security certificate provided by Efí within your account, in the PFX (.p12) format. This requirement is fully described in the PIX security manual(https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados).

If you don't have your certificate yet, just follow the step-by-step guide in the following link to generate a new one: Click Here

Module Configuration

1. Production Client_Id: Fill in with the production client_id of your Efí account. This field is mandatory and can be found in the "API" -> "Applications" menu.
2. Production Client_Secret: Fill in with the production client_secret of your Efí account. This field is mandatory and can be found in the "API" -> "Applications" menu.
3. Development Client_Id: Fill in with the development client_id of your Efí account. This field is mandatory and can be found in the "API" -> "Applications" menu.
4. Development Client_Secret: Fill in with the development client_secret of your Efí account. This field is mandatory and can be found in the "API" -> "Applications" menu.
5. Account Identifier: Fill in with the identifier of your Efí account. This field is mandatory and can be found in the "API" -> "Introduction" -> "Account Identifier" menu.
6. WHMCS Admin User: Fill in with the WHMCS admin user. You need to use the same user that the WHMCS admin uses to log in to the administrative area of your account. This field is mandatory.
7. Boleto Discount: Enter the discount value to be applied to boletos generated exclusively by Efí. This information is optional.
8. Discount Type: Enter the discount type (percentage or fixed amount) to be applied to boletos generated exclusively by Efí. This information is optional.
9. Number of Days for Boleto Expiration: Enter the number of elapsed days for the Efí boleto to expire after the charge is generated. If the field is empty, the value will be 0.
10. Efí Billing Email: If desired, enable sending Efí billing emails to the end customer.
11. Fine Configuration: If desired, enter the fine amount in percentage charged after the due date. For example, if you want 2%, you should enter 2. Minimum of 0.01 and maximum of 10. Integer.
12. Interest Configuration: Enter the daily interest amount charged after the due date. For example, if you want 0.033%, you should enter 0.033. Minimum of 0.001 and maximum of 0.33.
13. Note: Allows you to include a message for the customer on the boleto.
14. Sandbox: If desired, enable the Efí API test environment.
15. Debug: In this field, you can enable Efí transaction and error logs in the WHMCS panel.
16. PIX Key: If using CNPJ, enter it without dots or spaces, e.g., 11111111111121.
17. PIX Certificate: Fill in with the path of the certificate saved on your server during step 10 of the installation.
18. Discount: Enter the discount value to be applied to PIX generated exclusively by Efí.
19. PIX Expiration: Enter the validity period in days for the PIX charge.
20. Name: Enter the name of the account holder.
21. Document: Enter the document (CPF or CNPJ) of the account holder.
22. Agency: Enter the agency of the account holder.
23. Account Number: Enter the account number associated with the account holder.
24. Account Type: Enter the account type associated with the account holder.
25. Validate mTLS: Understand the risks of not configuring mTLS by accessing the link here.
26. PIX: Select this option if you want to enable PIX as a payment method.
27. Boleto: Select this option if you want to enable boleto as a payment method.
28. Credit Card: Select this option if you want to enable credit card as a payment method.
29. Open Finance: Select this option if you want to enable open finance as a payment method.