{"_id":"5760367c4715f61700ae860d","__v":36,"user":"57601a13af3e090e00108059","project":"575aeffae12cf20e002f306c","category":{"_id":"576030909b1a9a220067ca40","__v":0,"project":"575aeffae12cf20e002f306c","version":"575aeffae12cf20e002f306f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-14T16:28:00.991Z","from_sync":false,"order":11,"slug":"módulos","title":"Módulos"},"version":{"_id":"575aeffae12cf20e002f306f","project":"575aeffae12cf20e002f306c","__v":30,"createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","categories":["575aeffae12cf20e002f3070","575af039a083950e004487f7","575af5c7ba4ed70e000ca288","57602fe5b82256240055c657","57602ff6c811102000cef302","576030909b1a9a220067ca40","57604518b82256240055c722","5761a63d207db7170022fc14","5761b9a2b65324200072d79e","576832939f0bf4190014ffdf","576832c09f0bf4190014ffe1","576832cba151c10e004316f0","576832d5bb15f40e00a288ec","576832e107b1f30e0039c645","577680bf3cee3a0e00a000bc","577ff3b1ff48990e000c6806","5783f78c5cbce30e0074e2b7","5783f86292edb92200e6101c","5783f86dbfbba719003f0d8b","5783f8755cbce30e0074e2b8","5783f8b65cbce30e0074e2b9","5783f8bf5cbce30e0074e2ba","5783f8d8ce802f0e0087d574","578529f887c9280e0090394b","57852aeb87c9280e0090394d","57866e72b2f4060e00fa39ca","57ab6d5c39c2fd1900191879","57f39451ab0ee12000bef915","582499a0d90fa027009b259e","58c29df1258e5a1900b60478"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"2016","version_clean":"1.0.0","version":"1"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-14T16:53:16.650Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"**Módulo de Integração Gerencianet para WHMCS Oficial - Versão 0.3.0**\n\nO módulo Gerencianet para WHMCS permite receber pagamentos por meio do <strong>checkout transparente da nossa API</strong>. O módulo Gerencianet para o WHMCS permite **gerar e criar boletos com registro** por meio da nossa API. Compatível com as versões superiores a 6.0.4 do WHMCS (inclusive testado com a versão 7.1.1 do WHMCS).\n\nEste é 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.\n\n**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.\n\nPara ativar o callback automático do WHMCS para a Gerencianet, siga o 5º passo da seção *\"[2. Instalação do Módulo Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-2-instala-o-do-m-dulo-gerencianet-para-whmcs)\".*\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"OBSERVAÇÃO\",\n  \"body\": \"Para o correto funcionamento, recomendamos que leia com atenção este documento e faça exatamente o que está descrito com relação às configurações necessárias em nosso módulo, inclusive atentando-se aos requisitos de versões do PHP do servidor e do WHMCS.\"\n}\n[/block]\nVá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa:\n\n1. [Requisitos](https://dev.gerencianet.com.br/docs/whmcs#section-1-requisitos)\n\n2. [Instalação do Módulo Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-2-instala-o-do-m-dulo-gerencianet-para-whmcs)\n\n3. [Configurações do Módulo Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-3-configura-es-do-m-dulo-gerencianet-para-whmcs)\n\n4. [Como cancelar uma cobrança](https://dev.gerencianet.com.br/docs/whmcs#section-4-como-cancelar-uma-cobran-a)\n\n5. [Como alterar a data de vencimento da cobrança](https://dev.gerencianet.com.br/docs/whmcs#section-5-como-alterar-a-data-de-vencimento-da-cobran-a)\n\n6. [Descontos no WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-6-descontos-no-whmcs)\n\n7. [Erros Comuns de Integração](https://dev.gerencianet.com.br/docs/whmcs#section-7-erros-comuns-de-integra-o)\n\n8. [Outros módulos Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-8-outros-m-dulos-gerencianet-para-whmcs)\n\n\n## 1. Requisitos\n\n- Versão mínima do PHP: <code>5.4.39</code>\n- Versão mínima do WHMCS: <code>6.0.4</code>\n\n\n## 2. Instalação do Módulo Gerencianet para WHMCS\n\n1. <a href=\"https://codeload.github.com/gerencianet/gn-api-whmcs/zip/master\" target=\"_blank\">Faça o download</a> da última versão do módulo;\n\n2. Descompacte o arquivo baixado;\n\n3. Copie o arquivo <code>gerencianetcharge.php</code> e a pasta <code>gerencianet_lib</code>, disponíveis na pasta <code>gn-api-whmcs</code> de nosso módulo, para o diretório <code>modules/gateways</code> da instalação de seu WHMCS;\n\n4. Copie o arquivo <code>gerencianetcharge.php</code>, disponível no diretório <code>gn-api-whmcs/callback</code> de nosso módulo, para o diretório <code>modules/gateways/callback</code> da instalação de seu WHMCS. Ele deve seguir o modelo <code>modules/gateways/callback/gerencianetcharge.php</code>\n\n5. Copie o arquivo <code>gerencianet.php</code>, disponível no diretório <code>gn-api-whmcs/hooks</code> de nosso módulo e cole no diretório <code>/includes/hooks</code> da instalação de seu WHMCS. Ele deverá seguir o modelo <code>includes/hooks/gerencianet.php</code>.\n\nOs arquivos do módulo Gerencianet devem seguir a mesma estrutura no WHMCS, conforme abaixo:\n\n<pre>includes/hooks/\n  | gerencianet.php\n\nmodules/gateways/\n  | callback/gerencianetcharge.php\n  | gerencianet_lib/\n  | gerencianetcharge.php\n</pre>\n\n\n## 3. Configurações do Módulo Gerencianet para WHMCS\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a343976-parametros_configuracao.png\",\n        \"parametros_configuracao.png\",\n        1643,\n        727,\n        \"#ebebeb\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\nDentro do painel administrativo do WMCS, acesse o menu <code>Setup > Payments > Payment Gateways</code>. No campo <code>Active Module</code>, escolha a opção <code>Gerencianet</code>. A tela mostrada acima será exibida. Dentro do formulário, você deverá preencher os seguintes campos:\n\n**1. Client_Id Produção**: Deve ser preenchido com o <code>Client_Id</code> de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione a aplicação criada, conforme mostrado <a href=\"http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png\" target=\"_blank\">neste link</a>;\n\n**2. Client_Secret Produção**: Deve ser preenchido com o <code>Client_Secret</code> de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione a aplicação criada, conforme mostrado <a href=\"http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png\" target=\"_blank\">neste link</a>;\n\n**3. Client_Id Desenvolvimento**: Deve ser preenchido com o <code>Client_Id</code> de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione sua aplicação criada, conforme mostrado <a href=\"http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png\" target=\"_blank\">neste link</a>;\n\n**4. Client_Secret Desenvolvimento**: Deve ser preenchido com o <code>Client_Secret</code> de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione sua aplicação criada, conforme mostrado <a href=\"http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png\" target=\"_blank\">neste link</a>;\n\n**5. Identificador da Conta**: Deve ser preenchido com o identificador de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu \"API\", na tela principal e no canto superior esquerdo, conforme mostrado <a href=\"http://image.prntscr.com/image/cabe13e1e5b64449b942cf31139150ba.png\" target=\"_blank\">neste link</a>;\n\n**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;\n\n**7. Desconto do Boleto**: Informe o valor desconto que deverá ser aplicado aos boletos gerados exclusivamente pela Gerencianet. Esta informação é opcional;\n\n**8. Tipo de desconto**: Informe o tipo de desconto (porcentagem ou valor fixo) que deverá ser aplicado aos boletos gerados exclusivamente pela Gerencianet. Esta informação é opcional;\n\n**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;\n\n**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 e, caso você ainda não o tenha criado, vá ao painel administrativo do WHMCS em <code>Setup > Custom Client Fields</code> e configure um campo para receber tais valores. Ex: \"CPF/CNPJ\";\n\n**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. Assim, caso você queira limitar a geração de transações na Gerencianet para faturas do WHMCS com valores superiores à R$ 7,00, por exemplo, você deverá preencher este campo com <code>7.00</code>. O desconto oferecido no módulo pela Gerencianet (vide campo 7) não está incluído no cálculo deste valor minimo;\n\n**12. Sandbox**: Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet;\n\n**13. Debug**: Neste campo é possível habilitar os logs de transação e de erros da Gerencianet no painel WHMCS;\n\n**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;\n\n**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.\n\n**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;\n\n**17. Observação**: Permite incluir no boleto uma mensagem para o cliente.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Durante as configurações de nosso módulo, especificamente no item 10 (vide acima), é necessário que você tenha criado um campo customizado *(custom_field)* em seu WHMCS para receber o CPF e/ou CNPJ do cliente final. **A criação deste campo é obrigatória.**\\n\\nCaso não tenha criado, vá ao painel administrativo do WHMCS em <code>Setup > Custom Client Fields</code> e configure um campo para receber tais valores. Ex: \\\"CPF/CNPJ\\\".\\n\\n**Obs:** o campo customizado, referente ao CPF/CNPJ do cliente, não deve ter sua posição alterada. Sugerimos isto pois observamos relatos de usuários do WHMCS que alteraram a posição do campo e enfrentaram problemas com a coleta de dados do cliente.\\n\\n**NÃO ESQUEÇA: em nosso módulo, você deverá preencher o item 10 exatamente com o mesmo nome que você criou o campo customizado.**\",\n  \"title\": \"IMPORTANTE\"\n}\n[/block]\n## 4. Como cancelar uma cobrança\n\nA partir da versão 0.2.7 do módulo Gerencianet/WHMCS, disponibilizamos o callback automático do WHMCS para a Gerencianet nos casos de cancelamento da fatura. Portanto, sempre que uma fatura for cancelada no WHMCS, ela é automaticamente cancelada na Gerencianet.\n\nPara cancelar a cobrança no WHMCS, acesse <code>\"Orders > List All Orders\"</code>, clique no ID da *invoice* desejada. Em seguida, clique em <code>\"Cancel Order\"</code> (<a href=\"http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/93d867ee-fb78-4e32-88f5-a3648a8fdd8d/whmcs-cancel-order.png\" target=\"_blank\">veja onde</a>).\n\n\n## 5. Como alterar a data de vencimento da cobrança\n\nA partir da versão 0.2.7 do módulo Gerencianet/WHMCS, disponibilizamos o callback automático do WHMCS para a Gerencianet nos casos de atualização da data de vencimento do boleto. Portanto, sempre que a fatura tem a data de vencimento modificada, o boleto Gerencianet também tem sua data de vencimento atualizada.\n\nPara alterar o vencimento da cobrança, acesse <code>\"Orders > List All Orders\"</code>, clique na ID da invoice (<a href=\"http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/1370e079-b893-4ae9-83bb-3d6ccb9b6814/whmcs-vencimento-01.png\" target=\"_blank\">veja onde</a>), depois na sub-aba <code>\"Options\"</code> (<a href=\"http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/6f99b13f-5b6d-4170-ac6e-949183c11c98/whmcs-vencimento-02.png\" target=\"_blank\">veja onde</a>) e em <code>\"Due Date\"</code> selecione a nova data de vencimento (<a href=\"http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/f8b68f76-f8b4-41f0-a28b-ec3658ea0bcc/whmcs-vencimento-03.png\" target=\"_blank\">veja onde</a>), e em seguida, clique em <code>\"Save Changes\"</code>.\n\n\n## 6. Descontos no WHMCS\n\nNeste módulo de integração é possível gerar boletos considerando os descontos dos cupons promocionais fornecidos pelo WHMCS. Caso o integrador escolha uma das 4 formas de desconto do WHMCS (porcentagem, valor fixo, substituição de preço e isenção de tarifas), tal desconto é convertido em reais e repassado à API Gerencianet no momento da geração do boleto.\n\nAlém dos descontos fornecidos pelo WHMCS, é possível disponibilizar descontos exclusivos para os boletos gerados através do módulo Gerencianet. Esta opção de desconto é configurada nos campos <code>Desconto do Boleto</code> e <code>Tipo de desconto</code> do módulo Gerencianet. Uma vez configurado, este desconto será exibido no boleto Gerencianet e, assim que o mesmo for pago, o valor do pedido e da cobrança no WHMCS serão atualizados para o valor com o desconto Gerencianet.\n\nOutra forma de desconto, além das citadas anteriormente, são os créditos que o usuário possui no WHMCS. Assim, caso um cliente queira aplicar um determinado crédito no pedido do WHMCS, tal quantia será convertida em desconto no boleto Gerencianet.\n\n\n## 7. Erros Comuns de Integração\n\nAntes mesmo do módulo tentar gerar uma cobrança alguns campos requisitados na integração passam por uma validação. Os erros que esta validação podem retornar são:\n\n- **Nome Inválido**: O nome informado pelo cliente final é muito curto, assim, deve ser informado o nome completo;\n\n- **E-mail Inválido**: O email informado pelo cliente final é inválido (não segue o padrão xxxxx:::at:::xxxx.com) ou não existe;\n\n- **Telefone Inválido**: O telefone informado pelo cliente final não existe ou o DDD está incorreto;\n\n- **Documento Inválido**: O número do CPF/CNPJ do cliente final é invalido;\n\n- **Documento Nulo**: O campo referente ao CPF e/ou CNPJ do cliente não existe no WHMCS ou não está preenchido;\n\n- **Razão Social Inválida**: A Razão Social é inválida. O cliente deve digitar no campo \"Empresa\" do WHMCS o nome empresarial que consta na Receita Federal;\n\n- **Razão Social Nula**: O campo \"Empresa\" do WHMCS não está preenchido;\n\n- **Erro Inesperado**: Houve algum erro na integração. Provavelmente você não preencheu todos os campos do módulo corretamente, ou a versão do PHP do WHMCS não é compatível com a API Gerencianet. Você deverá ativar o modo Debug do módulo para saber mais detalhes.\n\nAinda que nenhum destes erros de validação sejam retornados, a API Gerencianet poderá retornar erros referentes à geração da cobrança. Para interpretar os retornos da API e, claro, corrigir possíveis erros de validação de dados ou outros similares, acesse a página \"<a href=\"https://dev.gerencianet.com.br/docs/interpretando-erros-api\" target=\"_blank\">Interpretando Erros da API</a>\".\n\n\n## 8. Outros módulos Gerencianet para WHMCS\n\nAlém do módulo para WHMCS desenvolvido internamente por nossa equipe, a Gerencianet possui parceiros oficiais que desenvolveram à parte módulos para o WHMCS. Se preferir, você pode utilizá-los:\n\n1. [Módulo Gerencianet para WHMCS](https://www.edvan.com.br/financeiro/gerencianet.php) *(desenvolvido por Edvan)*\n\n2. Módulo Gerencianet para WHMCS ([cartão de crédito](https://gofas.net/whmcs/modulo-gerencianet-cartao-para-whmcs-checkout-transparente-e-pagamento-recorrente/) e [boleto bancário](https://gofas.net/whmcs/modulo-gerencianet-boleto-para-whmcs/)) *(desenvolvido por Maurício Gofas)*\n\n\n## 9. Suporte e Sugestões\n\nSua sugestão de novas ideias e implementações para o módulo da Gerencianet para WHMCS é muito importante. Portanto, caso você tenha alguma ideia, entre em contato com a nossa equipe. Iremos analisar sua sugestão e avaliar a possibilidade de implantação.\n\nCaso você tenha alguma dúvida, entre em contato conosco pelo site [Gerencianet](https://gerencianet.com.br/).","excerpt":"Você está em: *\"Módulos > WHMCS\"*","slug":"whmcs","type":"basic","title":"WHMCS"}

WHMCS

Você está em: *"Módulos > WHMCS"*

**Módulo de Integração Gerencianet para WHMCS Oficial - Versão 0.3.0** O módulo Gerencianet para WHMCS permite receber pagamentos por meio do <strong>checkout transparente da nossa API</strong>. O módulo Gerencianet para o WHMCS permite **gerar e criar boletos com registro** por meio da nossa API. Compatível com as versões superiores a 6.0.4 do WHMCS (inclusive testado com a versão 7.1.1 do 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. Para ativar o callback automático do WHMCS para a Gerencianet, siga o 5º passo da seção *"[2. Instalação do Módulo Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-2-instala-o-do-m-dulo-gerencianet-para-whmcs)".* [block:callout] { "type": "warning", "title": "OBSERVAÇÃO", "body": "Para o correto funcionamento, recomendamos que leia com atenção este documento e faça exatamente o que está descrito com relação às configurações necessárias em nosso módulo, inclusive atentando-se aos requisitos de versões do PHP do servidor e do WHMCS." } [/block] Vá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa: 1. [Requisitos](https://dev.gerencianet.com.br/docs/whmcs#section-1-requisitos) 2. [Instalação do Módulo Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-2-instala-o-do-m-dulo-gerencianet-para-whmcs) 3. [Configurações do Módulo Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-3-configura-es-do-m-dulo-gerencianet-para-whmcs) 4. [Como cancelar uma cobrança](https://dev.gerencianet.com.br/docs/whmcs#section-4-como-cancelar-uma-cobran-a) 5. [Como alterar a data de vencimento da cobrança](https://dev.gerencianet.com.br/docs/whmcs#section-5-como-alterar-a-data-de-vencimento-da-cobran-a) 6. [Descontos no WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-6-descontos-no-whmcs) 7. [Erros Comuns de Integração](https://dev.gerencianet.com.br/docs/whmcs#section-7-erros-comuns-de-integra-o) 8. [Outros módulos Gerencianet para WHMCS](https://dev.gerencianet.com.br/docs/whmcs#section-8-outros-m-dulos-gerencianet-para-whmcs) ## 1. Requisitos - Versão mínima do PHP: <code>5.4.39</code> - Versão mínima do WHMCS: <code>6.0.4</code> ## 2. Instalação do Módulo Gerencianet para WHMCS 1. <a href="https://codeload.github.com/gerencianet/gn-api-whmcs/zip/master" target="_blank">Faça o download</a> da última versão do módulo; 2. Descompacte o arquivo baixado; 3. Copie o arquivo <code>gerencianetcharge.php</code> e a pasta <code>gerencianet_lib</code>, disponíveis na pasta <code>gn-api-whmcs</code> de nosso módulo, para o diretório <code>modules/gateways</code> da instalação de seu WHMCS; 4. Copie o arquivo <code>gerencianetcharge.php</code>, disponível no diretório <code>gn-api-whmcs/callback</code> de nosso módulo, para o diretório <code>modules/gateways/callback</code> da instalação de seu WHMCS. Ele deve seguir o modelo <code>modules/gateways/callback/gerencianetcharge.php</code> 5. Copie o arquivo <code>gerencianet.php</code>, disponível no diretório <code>gn-api-whmcs/hooks</code> de nosso módulo e cole no diretório <code>/includes/hooks</code> da instalação de seu WHMCS. Ele deverá seguir o modelo <code>includes/hooks/gerencianet.php</code>. Os arquivos do módulo Gerencianet devem seguir a mesma estrutura no WHMCS, conforme abaixo: <pre>includes/hooks/ | gerencianet.php modules/gateways/ | callback/gerencianetcharge.php | gerencianet_lib/ | gerencianetcharge.php </pre> ## 3. Configurações do Módulo Gerencianet para WHMCS [block:image] { "images": [ { "image": [ "https://files.readme.io/a343976-parametros_configuracao.png", "parametros_configuracao.png", 1643, 727, "#ebebeb" ], "caption": "" } ] } [/block] Dentro do painel administrativo do WMCS, acesse o menu <code>Setup > Payments > Payment Gateways</code>. No campo <code>Active Module</code>, escolha a opção <code>Gerencianet</code>. 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 <code>Client_Id</code> de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione a aplicação criada, conforme mostrado <a href="http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png" target="_blank">neste link</a>; **2. Client_Secret Produção**: Deve ser preenchido com o <code>Client_Secret</code> de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione a aplicação criada, conforme mostrado <a href="http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png" target="_blank">neste link</a>; **3. Client_Id Desenvolvimento**: Deve ser preenchido com o <code>Client_Id</code> de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione sua aplicação criada, conforme mostrado <a href="http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png" target="_blank">neste link</a>; **4. Client_Secret Desenvolvimento**: Deve ser preenchido com o <code>Client_Secret</code> de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu <code>API > Minhas Aplicações</code>. Em seguida, selecione sua aplicação criada, conforme mostrado <a href="http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png" target="_blank">neste link</a>; **5. Identificador da Conta**: Deve ser preenchido com o identificador de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu "API", na tela principal e no canto superior esquerdo, conforme mostrado <a href="http://image.prntscr.com/image/cabe13e1e5b64449b942cf31139150ba.png" target="_blank">neste link</a>; **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 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 exclusivamente 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 e, caso você ainda não o tenha criado, vá ao painel administrativo do WHMCS em <code>Setup > Custom Client Fields</code> e configure um campo para receber tais valores. Ex: "CPF/CNPJ"; **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. Assim, caso você queira limitar a geração de transações na Gerencianet para faturas do WHMCS com valores superiores à R$ 7,00, por exemplo, você deverá preencher este campo com <code>7.00</code>. O desconto oferecido no módulo pela Gerencianet (vide campo 7) não está incluído no cálculo deste valor minimo; **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. [block:callout] { "type": "danger", "body": "Durante as configurações de nosso módulo, especificamente no item 10 (vide acima), é necessário que você tenha criado um campo customizado *(custom_field)* em seu WHMCS para receber o CPF e/ou CNPJ do cliente final. **A criação deste campo é obrigatória.**\n\nCaso não tenha criado, vá ao painel administrativo do WHMCS em <code>Setup > Custom Client Fields</code> e configure um campo para receber tais valores. Ex: \"CPF/CNPJ\".\n\n**Obs:** o campo customizado, referente ao CPF/CNPJ do cliente, não deve ter sua posição alterada. Sugerimos isto pois observamos relatos de usuários do WHMCS que alteraram a posição do campo e enfrentaram problemas com a coleta de dados do cliente.\n\n**NÃO ESQUEÇA: em nosso módulo, você deverá preencher o item 10 exatamente com o mesmo nome que você criou o campo customizado.**", "title": "IMPORTANTE" } [/block] ## 4. Como cancelar uma cobrança A partir da versão 0.2.7 do módulo Gerencianet/WHMCS, disponibilizamos o callback automático do WHMCS para a Gerencianet nos casos de cancelamento da fatura. Portanto, sempre que uma fatura for cancelada no WHMCS, ela é automaticamente cancelada na Gerencianet. Para cancelar a cobrança no WHMCS, acesse <code>"Orders > List All Orders"</code>, clique no ID da *invoice* desejada. Em seguida, clique em <code>"Cancel Order"</code> (<a href="http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/93d867ee-fb78-4e32-88f5-a3648a8fdd8d/whmcs-cancel-order.png" target="_blank">veja onde</a>). ## 5. Como alterar a data de vencimento da cobrança A partir da versão 0.2.7 do módulo Gerencianet/WHMCS, disponibilizamos o callback automático do WHMCS para a Gerencianet nos casos de atualização da data de vencimento do boleto. Portanto, sempre que a fatura tem a data de vencimento modificada, o boleto Gerencianet também tem sua data de vencimento atualizada. Para alterar o vencimento da cobrança, acesse <code>"Orders > List All Orders"</code>, clique na ID da invoice (<a href="http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/1370e079-b893-4ae9-83bb-3d6ccb9b6814/whmcs-vencimento-01.png" target="_blank">veja onde</a>), depois na sub-aba <code>"Options"</code> (<a href="http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/6f99b13f-5b6d-4170-ac6e-949183c11c98/whmcs-vencimento-02.png" target="_blank">veja onde</a>) e em <code>"Due Date"</code> selecione a nova data de vencimento (<a href="http://content.screencast.com/users/tiagogerencianet/folders/Jing/media/f8b68f76-f8b4-41f0-a28b-ec3658ea0bcc/whmcs-vencimento-03.png" target="_blank">veja onde</a>), e em seguida, clique em <code>"Save Changes"</code>. ## 6. Descontos no WHMCS Neste módulo de integração é possível gerar boletos considerando os descontos dos cupons promocionais fornecidos pelo WHMCS. Caso o integrador escolha uma das 4 formas de desconto do WHMCS (porcentagem, valor fixo, substituição de preço e isenção de tarifas), tal desconto é convertido em reais e repassado à API Gerencianet no momento da geração do boleto. Além dos descontos fornecidos pelo WHMCS, é possível disponibilizar descontos exclusivos para os boletos gerados através do módulo Gerencianet. Esta opção de desconto é configurada nos campos <code>Desconto do Boleto</code> e <code>Tipo de desconto</code> do módulo Gerencianet. Uma vez configurado, este desconto será exibido no boleto Gerencianet e, assim que o mesmo for pago, o valor do pedido e da cobrança no WHMCS serão atualizados para o valor com o desconto Gerencianet. Outra forma de desconto, além das citadas anteriormente, são os créditos que o usuário possui no WHMCS. Assim, caso um cliente queira aplicar um determinado crédito no pedido do WHMCS, tal quantia será convertida em desconto no boleto Gerencianet. ## 7. Erros Comuns de Integração Antes mesmo do módulo tentar gerar uma cobrança alguns campos requisitados na integração passam por uma validação. Os erros que esta validação podem retornar são: - **Nome Inválido**: O nome informado pelo cliente final é muito curto, assim, deve ser informado o nome completo; - **E-mail Inválido**: O email informado pelo cliente final é inválido (não segue o padrão xxxxx@xxxx.com) ou não existe; - **Telefone Inválido**: O telefone informado pelo cliente final não existe ou o DDD está incorreto; - **Documento Inválido**: O número do CPF/CNPJ do cliente final é invalido; - **Documento Nulo**: O campo referente ao CPF e/ou CNPJ do cliente não existe no WHMCS ou não está preenchido; - **Razão Social Inválida**: A Razão Social é inválida. O cliente deve digitar no campo "Empresa" do WHMCS o nome empresarial que consta na Receita Federal; - **Razão Social Nula**: O campo "Empresa" do WHMCS não está preenchido; - **Erro Inesperado**: Houve algum erro na integração. Provavelmente você não preencheu todos os campos do módulo corretamente, ou a versão do PHP do WHMCS não é compatível com a API Gerencianet. Você deverá ativar o modo Debug do módulo para saber mais detalhes. Ainda que nenhum destes erros de validação sejam retornados, a API Gerencianet poderá retornar erros referentes à geração da cobrança. Para interpretar os retornos da API e, claro, corrigir possíveis erros de validação de dados ou outros similares, acesse a página "<a href="https://dev.gerencianet.com.br/docs/interpretando-erros-api" target="_blank">Interpretando Erros da API</a>". ## 8. Outros módulos Gerencianet para WHMCS Além do módulo para WHMCS desenvolvido internamente por nossa equipe, a Gerencianet possui parceiros oficiais que desenvolveram à parte módulos para o WHMCS. Se preferir, você pode utilizá-los: 1. [Módulo Gerencianet para WHMCS](https://www.edvan.com.br/financeiro/gerencianet.php) *(desenvolvido por Edvan)* 2. Módulo Gerencianet para WHMCS ([cartão de crédito](https://gofas.net/whmcs/modulo-gerencianet-cartao-para-whmcs-checkout-transparente-e-pagamento-recorrente/) e [boleto bancário](https://gofas.net/whmcs/modulo-gerencianet-boleto-para-whmcs/)) *(desenvolvido por Maurício Gofas)* ## 9. Suporte e Sugestões Sua sugestão de novas ideias e implementações para o módulo da Gerencianet para WHMCS é muito importante. Portanto, caso você tenha alguma ideia, entre em contato com a nossa equipe. Iremos analisar sua sugestão e avaliar a possibilidade de implantação. Caso você tenha alguma dúvida, entre em contato conosco pelo site [Gerencianet](https://gerencianet.com.br/).