{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"WHMCS - Pix","type":"basic","slug":"whmcs-pix","excerpt":"Saiba onde, como baixar e instalar nosso módulo/plugin WHMCS - Pix com a forma de pagamento: Pix","body":"**Módulo de Integração Gerencianet para WHMCS Oficial - Versão 1.0.0**\n\nO 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 <strong>checkout transparente</strong>. \n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"IMPORTANTE!\",\n  \"body\": \"Este módulo contempla apenas pagamentos utilizando o Pix.\\nPara pagamentos via Boleto, consulte a página **[WHMCS - Boletos](https://dev.gerencianet.com.br/docs/whmcs-boletos) **\"\n}\n[/block]\nEste é 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.\n[block:callout]\n{\n  \"type\": \"warning\",\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  \"title\": \"ATENÇÃO\"\n}\n[/block]\nVá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa:\n\n1. [Requisitos do sistema](#section-1-requisitos-do-sistema)\n\n2. [Instalação do Módulo Gerencianet para WHMCS](#section-2-instala-o-do-m-dulo-gerencianet-para-whmcs)\n\n    2.1 [Converter certificado .p12 para .pem](#section--a-id-conversao-a-converter-certificado-p12-para-pem)\n\n3. [Configurações do Módulo Gerencianet para WHMCS](#section-3-configura-es-do-m-dulo-gerencianet-para-whmcs)\n\n4. [Erros Comuns de Integração](#section-4-erros-comuns-de-integra-o)\n\n5. [Suporte e Sugestões](#section-9-suporte-e-sugest-es)\n\n\n# 1. Requisitos do sistema\n\n- Versão do PHP: <code>7.2 ou superior</code>\n- Versão do WHMCS: <code>8.0 ou superior</code>\nOs requisitos completos referentes ao WHMCS você encontra [aqui.](https://docs.whmcs.com/System_Requirements)\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Os requisitos do sistema foram definidos de acordo com os nossos testes. Se seu sistema não se encaixa nos requisitos, não significa que o módulo não vai funcionar em seu WHMCS, mas sim, que não testamos no mesmo ambiente. **Portanto, não garantimos o funcionamento deste módulo em ambientes diferentes dos citados acima.**\",\n  \"title\": \"ATENÇÃO\"\n}\n[/block]\n<hr>\n\n# 2. Instalação do Módulo Gerencianet para WHMCS - Pix\n\n1. <a href=\"https://codeload.github.com/gerencianet/gn-api-whmcs-pix/zip/main\" 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 **gerencianetpix.php** e a pasta **gerencianetpix**, para o diretório **/modules/gateways** da instalação do WHMCS;\n\n4. Altere as permissões do arquivo copiado utilizando o comando abaixo\n`chmod 777 modules/gateways/gerencianetpix.php`\n\n5. Altere as permissões da pasta copiada utilizando o comando abaixo\n`chmod 777 modules/gateways/gerencianetpix/ -R`\n\n6. 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*\n\n7. Altere as permissões do arquivo copiado utilizando o comando abaixo\n`chmod 777 modules/gateways/callback/gerencianetpix.php`\n\n8. Copie o arquivo **gerencianet.php**, disponível no diretório **hooks**, para o diretório **includes/hooks**. Ele deve estar no caminho **includes/hooks/gerencianet.php**\n\n9. Altere as permissões do arquivo copiado utilizando o comando: `chmod 777 includes/hooks/gerencianet.php`\n\n10. 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 sessão: [**Converter certificado .p12 para .pem**](#section--a-id-conversao-a-converter-certificado-p12-para-pem)\n\nAo final da instalação, os arquivos do módulo Gerencianet devem estar na seguinte estrutura no WHMCS:\n```\nincludes/hooks/\n  |- gerencianet.php\n modules/gateways/\n  |- callback/gerencianetpix.php\n  |- gerencianetpix/\n  |- gerencianetpix.php\n```\n<br>\n## Converter certificado .p12 para .pem\nTodas 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 [manual de segurança do PIX](https://www.bcb.gov.br/estabilidadefinanceira/comunicacaodados).\n\nCaso ainda não tenha seu certificado, basta seguir o passo a passo do link a seguir para gerar um novo: [Clique Aqui](https://gerencianet.com.br/artigo/como-gerar-o-certificado-para-usar-a-api-pix/)\n\nPara converter seu certificado de .p12 para .pem, basta utilizar o conversor de certificados disponibilizado pela Gerencianet no link: [Clique aqui](https://pix.gerencianet.com.br/ferramentas/conversorGerencianet.exe)\n\n\n<hr>\n\n# 3. Configurações do Módulo Gerencianet para WHMCS\n\nDentro do painel administrativo do WHMCS, 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 abaixo será exibida. Dentro do formulário, você deverá preencher os seguintes campos:\n\n![Tela de Configuração](https://gnetbr.com/B1glJBqjBO)\n1. **Client_Id Produção:** Deve ser preenchido com o client_id de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu \"API\" -> \"Minhas Aplicações\". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/Ske9THqjrO);\n\n2. **Client_Secret Produção:** Deve ser preenchido com o client_secret de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu \"API\" ->  \"Minhas Aplicações\". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/Ske9THqjrO);\n\n3. **Client_Id Desenvolvimento:** Deve ser preenchido com o client_id de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu \"API\" -> \"Minhas Aplicações\". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/BJe-vIciHd);\n\n4. **Client_Secret Desenvolvimento:** Deve ser preenchido com o client_secret de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu \"API\" -> \"Minhas Aplicações\". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/BJe-vIciHd);\n\n5. **Sandbox:** Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet;\n\n6. **Debug:** Neste campo é possível habilitar os logs de transação e de erros da Gerencianet no painel WHMCS;\n\n7. **Certificado Pix** Deve ser preenchido com o caminho do certificado salvo em seu servidor no passo 10 da instalação;\n\n8. **Desconto:** Informe o valor de desconto que deverá ser aplicado ao pix gerado exclusivamente pela Gerencianet;\n\n9. **Validade da Cobrança** Deve ser informado o período de validade em dias da cobrança PIX;\n\n10. **Mtls** Entenda os riscos de não configurar o mTLS acessando o link https://gnetbr.com/rke4baDVyd.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Importante salientar que **as cobranças geradas em sandbox não são válidas e não podem ser pagas**.\\n\\nÉ importante saber que as palavras **Sandbox, Ambiente de Homologação e Ambiente de Desenvolvimento**, no contexto da Gerencianet, são sinônimos no sentido de fazerem referência ao local de testes que oferecemos em que você pode testar à vontade sua integração com a API.\"\n}\n[/block]\n<br>\n<hr>\n\n# 4. 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<br>\n\n<hr>\n\n# 5. 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/).","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60b780a6b3473402516a9a50","createdAt":"2021-06-02T12:59:18.604Z","user":"5e8b36bc27ee9b00181b36bf","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Módulos e Plugins","slug":"módulos","order":17,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba91007878342e","__v":0,"createdAt":"2016-06-14T16:28:00.991Z","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6"},"version":{"version":"1.1.0","version_clean":"1.1.0","codename":"2021","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["606f2ca6c5ba91007878342b","575af039a083950e004487f7","575af5c7ba4ed70e000ca288","606f2ca6c5ba91007878342c","606f2ca6c5ba91007878342d","606f2ca6c5ba91007878342e","606f2ca6c5ba91007878342f","5761a63d207db7170022fc14","5761b9a2b65324200072d79e","576832939f0bf4190014ffdf","576832c09f0bf4190014ffe1","576832cba151c10e004316f0","576832d5bb15f40e00a288ec","576832e107b1f30e0039c645","606f2ca6c5ba910078783430","606f2ca6c5ba910078783431","5783f78c5cbce30e0074e2b7","606f2ca6c5ba910078783432","606f2ca6c5ba910078783433","606f2ca6c5ba910078783434","606f2ca6c5ba910078783435","606f2ca6c5ba910078783436","606f2ca6c5ba910078783437","578529f887c9280e0090394b","606f2ca6c5ba910078783438","606f2ca6c5ba910078783439","606f2ca6c5ba91007878343a","606f2ca6c5ba91007878343b","606f2ca6c5ba91007878343c","606f2ca6c5ba91007878343d","606f2ca6c5ba91007878343e","606f2ca6c5ba91007878343f","606f2ca6c5ba910078783440","606f2ca6c5ba910078783441","60d61f026ddc3901a32ee5f1","60ec37c637005f015e54174e"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":2,"forked_from":"575aeffae12cf20e002f306f"},"project":"575aeffae12cf20e002f306c","__v":0,"parentDoc":null}

WHMCS - Pix

Saiba onde, como baixar e instalar nosso módulo/plugin WHMCS - Pix com a forma de pagamento: Pix

**Módulo de Integração Gerencianet para WHMCS Oficial - Versão 1.0.0** 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 <strong>checkout transparente</strong>. [block:callout] { "type": "danger", "title": "IMPORTANTE!", "body": "Este módulo contempla apenas pagamentos utilizando o Pix.\nPara pagamentos via Boleto, consulte a página **[WHMCS - Boletos](https://dev.gerencianet.com.br/docs/whmcs-boletos) **" } [/block] 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. [block:callout] { "type": "warning", "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**.", "title": "ATENÇÃO" } [/block] Vá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa: 1. [Requisitos do sistema](#section-1-requisitos-do-sistema) 2. [Instalação do Módulo Gerencianet para WHMCS](#section-2-instala-o-do-m-dulo-gerencianet-para-whmcs) 2.1 [Converter certificado .p12 para .pem](#section--a-id-conversao-a-converter-certificado-p12-para-pem) 3. [Configurações do Módulo Gerencianet para WHMCS](#section-3-configura-es-do-m-dulo-gerencianet-para-whmcs) 4. [Erros Comuns de Integração](#section-4-erros-comuns-de-integra-o) 5. [Suporte e Sugestões](#section-9-suporte-e-sugest-es) # 1. Requisitos do sistema - Versão do PHP: <code>7.2 ou superior</code> - Versão do WHMCS: <code>8.0 ou superior</code> Os requisitos completos referentes ao WHMCS você encontra [aqui.](https://docs.whmcs.com/System_Requirements) [block:callout] { "type": "warning", "body": "Os requisitos do sistema foram definidos de acordo com os nossos testes. Se seu sistema não se encaixa nos requisitos, não significa que o módulo não vai funcionar em seu WHMCS, mas sim, que não testamos no mesmo ambiente. **Portanto, não garantimos o funcionamento deste módulo em ambientes diferentes dos citados acima.**", "title": "ATENÇÃO" } [/block] <hr> # 2. Instalação do Módulo Gerencianet para WHMCS - Pix 1. <a href="https://codeload.github.com/gerencianet/gn-api-whmcs-pix/zip/main" target="_blank">Faça o download</a> 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 abaixo `chmod 777 modules/gateways/gerencianetpix.php` 5. Altere as permissões da pasta copiada utilizando o comando abaixo `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 abaixo `chmod 777 modules/gateways/callback/gerencianetpix.php` 8. Copie o arquivo **gerencianet.php**, disponível no diretório **hooks**, para o diretório **includes/hooks**. Ele deve estar no caminho **includes/hooks/gerencianet.php** 9. Altere as permissões do arquivo copiado utilizando o comando: `chmod 777 includes/hooks/gerencianet.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 sessão: [**Converter certificado .p12 para .pem**](#section--a-id-conversao-a-converter-certificado-p12-para-pem) Ao final da instalação, os arquivos do módulo Gerencianet devem estar na seguinte estrutura no WHMCS: ``` includes/hooks/ |- gerencianet.php modules/gateways/ |- callback/gerencianetpix.php |- gerencianetpix/ |- gerencianetpix.php ``` <br> ## 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 [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: [Clique Aqui](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: [Clique aqui](https://pix.gerencianet.com.br/ferramentas/conversorGerencianet.exe) <hr> # 3. Configurações do Módulo Gerencianet para WHMCS Dentro do painel administrativo do WHMCS, 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 abaixo será exibida. Dentro do formulário, você deverá preencher os seguintes campos: ![Tela de Configuração](https://gnetbr.com/B1glJBqjBO) 1. **Client_Id Produção:** Deve ser preenchido com o client_id de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Minhas Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/Ske9THqjrO); 2. **Client_Secret Produção:** Deve ser preenchido com o client_secret de produção de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Minhas Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/Ske9THqjrO); 3. **Client_Id Desenvolvimento:** Deve ser preenchido com o client_id de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Minhas Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/BJe-vIciHd); 4. **Client_Secret Desenvolvimento:** Deve ser preenchido com o client_secret de desenvolvimento de sua conta Gerencianet. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Minhas Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no [link](https://gnetbr.com/BJe-vIciHd); 5. **Sandbox:** Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet; 6. **Debug:** Neste campo é possível habilitar os logs de transação e de erros da Gerencianet no painel WHMCS; 7. **Certificado Pix** Deve ser preenchido com o caminho do certificado salvo em seu servidor no passo 10 da instalação; 8. **Desconto:** Informe o valor de desconto que deverá ser aplicado ao pix gerado exclusivamente pela Gerencianet; 9. **Validade da Cobrança** Deve ser informado o período de validade em dias da cobrança PIX; 10. **Mtls** Entenda os riscos de não configurar o mTLS acessando o link https://gnetbr.com/rke4baDVyd. [block:callout] { "type": "danger", "body": "Importante salientar que **as cobranças geradas em sandbox não são válidas e não podem ser pagas**.\n\nÉ importante saber que as palavras **Sandbox, Ambiente de Homologação e Ambiente de Desenvolvimento**, no contexto da Gerencianet, são sinônimos no sentido de fazerem referência ao local de testes que oferecemos em que você pode testar à vontade sua integração com a API." } [/block] <br> <hr> # 4. 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 [email protected]) 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>". <br> <hr> # 5. 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/).