WHMCS Gerencianet Oficial - Pix

ATENÇÃO: PARA UM ATENDIMENTO MAIS RÁPIDO, SOLICITE SUPORTE NO LINK A SEGUIR https://sistema.gerencianet.com.br/tickets/criar/

O módulo Gerencianet para WHMCS permite gerar cobranças para serem pagas via Pix por meio da nossa API. Além disso, permite receber pagamentos com QrCode ou utilizando o código Copia e Cola, isso através do checkout transparente.

Este é o Módulo Oficial de integração fornecido pela Gerencianet para o WHMCS. Com ele, o responsável pela conta WHMCS pode receber pagamentos via Pix e, assim que a cobrança tem uma confirmação de pagamento ou é cancelada, a Gerencianet envia uma notificação automática para o WHMCS.

Para mais detalhes: https://dev.gerencianet.com.br/docs/whmcs-pix

Instalação

1. Faça o download da última versão do módulo;
2. Descompacte o arquivo baixado;
3. Copie o arquivo gerencianetpix.php e a pasta gerencianetpix, 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/gerencianetpix.php
5. Altere as permissões da pasta copiada utilizando o comando: chmod 777 modules/gateways/gerencianetpix/ -R
6. Copie o arquivo gerencianetpix.php, disponível no diretório callback, para o diretório modules/gateways/callback. Ele deve estar no caminho: modules/gateways/callback/gerencianetpix.php
7. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 modules/gateways/callback/gerencianetpix.php
8. Copie o arquivo gerencianetpix.php, disponível no diretório hooks, para o diretório includes/hooks. Ele deve estar no caminho includes/hooks/gerencianetpix.php
9. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 includes/hooks/gerencianetpix.php
10. Crie uma pasta na raiz do seu servidor e insira seu certificado na pasta. Vale lembrar que seu certificado deve estar no formato .pem. Você encontra o passo a passo de conversão na próxima sessão.

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

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

Converter certificado .p12 para .pem

Todas as requisições devem conter um certificado de segurança que será fornecido pela Gerencianet dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na integra no link: 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/

Para converter seu certificado de .p12 para .pem, basta utilizar o conversor de certificados disponibilizado pela Gerencianet no link: https://pix.gerencianet.com.br/ferramentas/conversorGerencianet.exe

Configuração do Módulo

1. Client_Id Produção: Deve ser preenchido com o client_id de produção de sua conta Gerencianet;
2. Client_Secret Produção: Deve ser preenchido com o client_secret de produção de sua conta Gerencianet;
3. Client_Id Desenvolvimento: Deve ser preenchido com o client_id de desenvolvimento de sua conta Gerencianet;
4. Client_Secret Desenvolvimento: Deve ser preenchido com o client_secret de desenvolvimento de sua conta Gerencianet;
5. Chave PIX: Se utilizado CNPJ, informar sem pontos e espaços, ex. 11111111111121;
6. Sandbox: Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet;
7. Debug: Neste campo é possível habilitar os logs de transação e de erros da Gerencianet no painel WHMCS;
8. Certificado Pix Deve ser preenchido com o caminho do certificado salvo em seu servidor no passo 10 da instalação;
9. Desconto: Informe o valor de desconto que deverá ser aplicado ao pix gerado exclusivamente pela Gerencianet;
10. Validade da Cobrança Deve ser informado o período de validade em dias da cobrança PIX;
11. Mtls Entenda os riscos de não configurar o mTLS acessando o link https://gnetbr.com/rke4baDVyd.

English Translation

WHMCS Gerencianet Official - Pix

ATTENTION: FOR FASTER SERVICE, REQUEST SUPPORT AT THE FOLLOWING LINK https://sistema.gerencianet.com.br/tickets/criar/

The Gerencianet module for WHMCS allows you to generate charges to be paid via Pix through our API. In addition, it allows you to receive payments with QrCode or using the Copia e Cola code, through transparent checkout.

This is the Official Integration Module provided by Gerencianet for WHMCS. With it, the responsible for the WHMCS account can receive payments via Pix and, as soon as the charge has a payment confirmation or is canceled, Gerencianet sends an automatic notification to the WHMCS.

For more details: https://dev.gerencianet.com.br/docs/whmcs-pix

Installation

1. Download the latest version of the module;
2. Unzip the downloaded file;
3. Copy the gerencianetpix.php file and the gerencianetpix folder to the /modules/gateways directory of the WHMCS installation;
4. Change the permissions of the copied file using the command: chmod 777 modules/gateways/gerencianetpix.php
5. Change the permissions of the copied folder using the command: chmod 777 modules/gateways/gerencianetpix/ -R
6. Copy the gerencianetpix.php file, available in the callback directory, to the modules/gateways/callback directory. It should be in the path: modules/gateways/callback/gerencianetpix.php
7. Change the permissions of the copied file using the command: chmod 777 modules/gateways/callback/gerencianetpix.php
8. Copy the gerencianetpix.php file, available in the hooks directory, to the includes/hooks directory. It should be in the path includes/hooks/gerencianetpix.php
9. Change the permissions of the copied file using the command: chmod 777 includes/hooks/gerencianetpix.php
10. Create a folder at the root of your server and enter your certificate into the folder. Remember that your certificate must be in .pem format. You will find the conversion step by step in the next section.

At the end of the installation, the Gerencianet module files must be in the following structure in WHMCS:

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

Convert .p12 certificate to .pem

All requests must contain a security certificate that will be provided by Gerencianet within your account, in PFX(.p12) format. This requirement is fully described at the link: https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados

If you still don't have your certificate, just follow the link step-by-step to generate a new one: https://gerencianet.com.br/artigo/como-gerar-o-certificado-para-usar-a-api- pix/

To convert your certificate from .p12 to .pem, just use the certificate converter provided by Gerencianet at the link: https://pix.gerencianet.com.br/ferramentas/conversorGerencianet.exe

Module Configuration

1. Production Client_Id: Must be filled with the production client_id of your Gerencianet account;
2. Production Client_Secret: Must be filled with the production client_secret of your Gerencianet account;
3. Development Client_Id: Must be filled with the development client_id of your Gerencianet account;
4. Client_Secret Development: Must be filled with the development client_secret of your Gerencianet account;
5. PIX key: If using CNPJ, inform without dots and spaces, e.g. 11111111111121;
6. Sandbox: If you are interested, enable the Gerencianet API testing environment;
7. Debug: In this field it is possible to enable the Gerencianet transaction and error logs in the WHMCS panel;
8. Pix Certificate Must be filled in with the certificate path saved on your server in step 10 of installation;
9. Discount: Inform the discount amount that should be applied to the pix generated exclusively by Gerencianet;
10. Bill Validity The validity period in days of the PIX billing must be informed;
11. Mtls Understand the risks of not configuring mTLS by accessing the link https://gnetbr.com/rke4baDVyd.