WHMCS Gerencianet Oficial - Boletos

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 e criar boletos por meio da nossa API. Além disso, permite receber pagamentos por meio de checkout transparente.

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

Este é uma versão do Módulo Oficial de integração fornecido pela Gerencianet para WHMCS. Com ele, o responsável pela conta WHMCS pode receber pagamentos por boleto bancário 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.

A partir da versão 0.2.7 do módulo Gerencianet/WHMCS foi disponibilizado o callback automático do WHMCS para a Gerencianet nos casos de cancelamento da fatura e de atualização da data de vencimento do boleto. Portanto, sempre que uma fatura for cancelada no WHMCS ela é automaticamente cancelada na Gerencianet, e sempre que a fatura tem a data de vencimento modificada, o boleto Gerencianet também tem sua data de vencimento atualizada.

Instalação

1. Faça o download da última versão do módulo;
2. Descompacte o arquivo baixado;
3. Copie o arquivo gerencianetcharge.php e a pasta gerencianet_lib, disponíveis na pasta gn-api-whmcs, para o diretório /modules/gateways da instalação do WHMCS;
4. Copie o arquivo gerencianetcharge.php, disponível no diretório gn-api-whmcs/callback, para o diretório modules/gateways/callback. Ele deve seguir o modelo modules/gateways/callback/gerencianetcharge.php.
5. Copie o arquivo gerencianet.php, disponível no diretório gn-api-whmcs/hooks, para o diretório includes/hooks. Ele deverá seguir o modelo includes/hooks/gerencianet.php

Os arquivos do módulo Gerencianet devem seguir a seguinte estrutura no WHMCS:

 includes/hooks/
  |- gerencianet.php
 modules/gateways/
  |- callback/gerencianetcharge.php
  |  gerencianet_lib/
  |  gerencianetcharge.php

Configuração de Campo Personalizado

• Para que o módulo funcione, é necessário um campo de cliente personalizado, que receberá os valores para CPF ou CNPJ.
• No painel administrativo do WHMCS, acesse: "Opções" >> "Campos Personalizados" >> "Adicionar".

Configuração do Módulo

Dentro do painel administrativo do WHMCS, acesse o menu "Setup" -> "Payments" -> "Payment Gateways". No campo "Active Module", escolha a opção Gerencianet. A tela mostrada acima será exibida. Dentro do formulário, você deverá preencher os seguintes campos:

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. Identificador da Conta: Deve ser preenchido com o identificador de sua conta Gerencianet;
6. Usuario administrador do WHMCS: Deve ser preenchido com o usuário administrador do WHMCS.
7. Desconto do Boleto: Informe o valor desconto que deverá ser aplicado aos boletos gerados pela Gerencianet. Esta informação é opcional;
8. Tipo de desconto: Informe o tipo de desconto (porcentagem ou valor fixo) que deverá ser aplicado aos boletos gerados pela Gerencianet. Esta informação é opcional;
9. Numero de dias para o vencimento da cobrança: Informe o número de dias corridos para o vencimento do boleto Gerencianet após a cobrança ser gerada. Se o campo estiver vazio, o valor será 0;
10. Nome do campo referente ao CPF e/ou CNPJ: Deve ser informado o nome do campo que o administrador do WHMCS criou para receber o CPF e/ou CNPJ do cliente final. Este campo é obrigatório;
11. Valor mínimo da fatura: Neste campo deve ser informado o valor mínimo da fatura no WHMCS para que o boleto Gerencianet seja gerado.
12. Sandbox: Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet;
13. Debug: Neste campo é possível habilitar os logs de transação e de erros da Gerencianet no painel WHMCS;
14. E-mail de cobrança - Gerencianet: Caso seja de seu interesse, habilite o envio de emails de cobrança da Gerencianet para o cliente final;
15. 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.
16. 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;
17. Observação: Permite incluir no boleto uma mensagem para o cliente;

English Translation

WHMCS Gerencianet Official - Bank Slip

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 and create boletos through our API. In addition, it allows you to receive payments through transparent checkout.

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

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

As of version 0.2.7 of the Gerencianet/WHMCS module, the automatic callback from WHMCS to Gerencianet was made available in cases of invoice cancellation and payment slip due date update. Therefore, whenever an invoice is canceled in WHMCS, it is automatically canceled in Gerencianet, and whenever the invoice has its due date modified, the Gerencianet billet also has its due date updated.

Installation

1. Download the latest version of the module;
2. Unzip the downloaded file;
3. Copy the managernetcharge.php file and the managernet_lib folder, available in the gn-api-whmcs folder, to the /modules/gateways directory of the WHMCS installation;
4. Copy the managernetcharge.php file, available in the gn-api-whmcs/callback directory, to the modules/gateways/callback directory. It should follow the modules/gateways/callback/gerencianetcharge.php template.
5. Copy the managernet.php file, available in the gn-api-whmcs/hooks directory, to the includes/hooks directory. It should follow the includes/hooks/gerencianet.php template

The Gerencianet module files must follow the following structure in WHMCS:

  includes/hooks/
   |- managernet.php
  modules/gateways/
   |- callback/managenetcharge.php
   | managernet_lib/
   | managernetcharge.php

Custom Field Setup

• For the module to work, a custom customer field is required, which will receive the values ​​for CPF or CNPJ.
• On the WHMCS admin panel, go to: "Options" >> "Custom Fields" >> "Add".

Module Configuration

Within the WHMCS admin panel, go to the menu "Setup" -> "Payments" -> "Payment Gateways". In the field "Active Module", choose the option Gerencianet. The screen shown above will be displayed. Within the form, you must fill in the following fields:

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. Account Identifier: Must be filled in with your Gerencianet account identifier;
6. WHMCS admin user: Must be filled in with the WHMCS admin user.
7. Boleto discount: Inform the discount amount that should be applied to the slips generated by Gerencianet. This information is optional;
8. Type of discount: Inform the type of discount (percentage or fixed amount) that should be applied to slips generated by Gerencianet. This information is optional;
9. Number of days for the billing to expire: Inform the number of calendar days for the Gerencianet boleto to expire after the bill is generated. If the field is empty, the value will be 0;
10. Field name referring to the CPF and/or CNPJ: The name of the field that the WHMCS administrator created to receive the CPF and/or CNPJ of the end customer must be informed. This field is required;
11. Minimum invoice amount: In this field, the minimum invoice amount must be entered in WHMCS so that the Gerencianet billet is generated.
12. Sandbox: If you are interested, enable the Gerencianet API testing environment;
13. Debug: In this field it is possible to enable the Gerencianet transaction and error logs in the WHMCS panel;
14. E-mail billing - Gerencianet: If it is of interest to you, enable the sending of billing emails from Gerencianet to the end customer;
15. Fine Configuration: If it is of interest to you, inform the amount, in percentage, of the fine charged after expiration. For example: if you want 2%, you would enter 2. Minimum 0.01 and maximum 10. Integer.
16. Interest Setting: amount of interest charged per day after the due date. For example: if you want 0.033%, you would enter 0.033. Minimum of 0.001 and maximum of 0.33;
17. Note: Allows you to include a message to the customer in the bank slip;