{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Box Billing","type":"basic","slug":"box-billing","excerpt":"Saiba onde, como baixar e instalar nosso módulo/plugin Box Billing com a forma de pagamento: Boleto bancário","body":"**Módulo de Integração Gerencianet para Boxbilling Oficial - Versão 0.2.1 (Beta)**\n\n**O módulo Gerencianet para o Boxbilling permite gerar boletos com registro por meio da nossa API.** Compatível com as versões superiores a versão 4.19 do Boxbilling.\n\nEste é uma versão Beta do Módulo Oficial de integração fornecido pela Gerencianet para **Boxbilling**. Com ele, o responsável pela conta **Box Billing** 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 Boxbilling.\n\nCaso você tenha alguma dúvida ou sugestão, entre em contato conosco pelo site Gerencianet.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Caso você tenha ativado o Bolix em sua conta Gerencianet, as cobranças geradas pelo nosso módulo/plugin já vão vir com o pix no boleto.\\nMais detalhes sobre o Bolix e como ativá-lo <a href=\\\"https://dev.gerencianet.com.br/docs/bolix-boleto-carne\\\" target=\\\"_blank\\\" title=\\\"Saiba mais sobre o Bolix\\\">aqui</a>\",\n  \"title\": \"Bolix\"\n}\n[/block]\n# 1. Requisitos\n\n- Versão mínima do PHP: <code>5.4.39</code>\n- Versão mínima do Boxbilling: <code>4.19</code>\n\n<br>\n\n<hr>\n\n# 2. Instalação\n\n1. Faça o <a href=\"https://codeload.github.com/gerencianet/gn-api-boxbilling/zip/master\" target=\"_blank\" title=\"Efetuar Download\">download da última versão do módulo</a>;\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-boxbilling</code>) e cole no diretório <code>/bb-library/Payment/Adapter/</code> da instalação do Box Billing;\n\n4. Copie a imagem <code>gerencianetcharge.png</code> (disponível no diretório <code>gn-api-boxbilling</code>) e cole no diretório <code>/bb-themes/huraga/assets/img/gateway_logos</code>;\n\n5. No final do arquivo <code>logos.css</code>, localizado no diretório <code>/bb-themes/huraga/assets/css/</code>, cole o seguinte trecho de código:\n\n<pre>.logo-gerencianetcharge{\n   background: transparent url(\"../img/gateway_logos/gerencianetcharge.png\") no-repeat scroll 0% 0%;\n    background-size: contain;\n    width:135px;\n    height: 25px;\n    border: 0;\n    margin: 10px;\n}</pre>\n<br>\nOs arquivos do módulo Gerencianet devem estar com a seguinte estrutura no Box Billing:\n\n<pre>/bb-library/Payment/Adapter/\n  |  gerencianet_lib/\n  |  gerencianetcharge.php\n</pre>\n\n<br>\n\n## Configurações do Módulo\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/af10055-parametros_configuracao1.png\",\n        \"parametros_configuracao[1].png\",\n        1152,\n        981,\n        \"#f7f7f7\"\n      ]\n    }\n  ]\n}\n[/block]\nDentro do painel administrativo do Boxbilling, acesse o menu <code>Configuration > Payment Gateways</code>. Clique para editar as configurações do módulo <code>gerencianetcharge</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 sua aplicação criada, conforme é mostrado <a href=\"https://gnetbr.com/HylbqtQSz_\" 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 sua aplicação criada, conforme é mostrado <a href=\"https://gnetbr.com/HylbqtQSz_\" target=\"_blank\">neste link</a>;\n\n**3. Client_Id Homologação:** Deve ser preenchido com o <code>Client_Id</code> de Homologação 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=\"https://gnetbr.com/SyebXcmBfO\" target=\"_blank\">neste link</a>;\n\n**4. Client_Secret Homologação:** Deve ser preenchido com o <code>Client_Secret</code> de Homologação 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=\"https://gnetbr.com/SyebXcmBfO\" 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. Confira onde localizá-lo em sua plataforma (<a href=\"https://cdn.discordapp.com/attachments/652136190006525955/809138574549188618/identificador-conta.jpg\" target=\"_blank\">Identificador da Conta</a>);\n\n**6. 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**7. Sandbox:** Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet;\n\n**8. Moeda:** Escolha a opção <code>R$ Real</code> (a mesma deve estar definida no seu Boxbilling);\n\n**9. Enabled:** Escolha a opção <code>Yes</code> para ativar o módulo da Gerencianet;\n\n**10. Allow one time payments:** Marque a opção <code>Yes</code>;\n\n**11. Allow subscription payments:** Marque a opção <code>No</code> (o módulo Gerencianet não suporta transações por assinatura);\n\nPor fim, clique em <code>UPDATE</code>.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"ATENÇÃO\",\n  \"body\": \"Importante salientar que **os boletos gerados em sandbox não são válidos e não podem ser pagos**, possuem a linha digitável \\\"zerada\\\" e uma marca d'água ao fundo informando ser um boleto de teste.\\n\\n**Os pagamentos de cobranças de sandbox utilizando cartão de crédito são fictícios, mesmo se utilizar um cartão \\\"real\\\".** Todos os pagamentos de cartão neste ambiente terão o pagamento confirmado automaticamente, mas é apenas uma alteração de status para \\\"Pago\\\". Este recurso permite que você teste a notificação do status <code>paid</code>.\\n\\n**Isso significa que todos os pagamentos realizados em sandbox não são reais e, portanto, não há cobrança de nenhuma importância financeira.** \\n\\nÉ importante saber que as palavras **Playground, Sandbox e Ambiente de Homologação**, 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# 3. Erros Comuns de Integração\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>\".","updates":[],"order":9,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"606f2ca7c5ba910078783479","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Módulos e Plugins","slug":"módulos","order":18,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba91007878342e","__v":0,"createdAt":"2016-06-14T16:28:00.991Z","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6"},"githubsync":"","parentDoc":null,"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","61473375119247002a9c14d7"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":3,"forked_from":"575aeffae12cf20e002f306f"},"project":"575aeffae12cf20e002f306c","__v":0,"createdAt":"2016-11-23T12:52:20.594Z","user":"57601a13af3e090e00108059"}

Box Billing

Saiba onde, como baixar e instalar nosso módulo/plugin Box Billing com a forma de pagamento: Boleto bancário

**Módulo de Integração Gerencianet para Boxbilling Oficial - Versão 0.2.1 (Beta)** **O módulo Gerencianet para o Boxbilling permite gerar boletos com registro por meio da nossa API.** Compatível com as versões superiores a versão 4.19 do Boxbilling. Este é uma versão Beta do Módulo Oficial de integração fornecido pela Gerencianet para **Boxbilling**. Com ele, o responsável pela conta **Box Billing** 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 Boxbilling. Caso você tenha alguma dúvida ou sugestão, entre em contato conosco pelo site Gerencianet. [block:callout] { "type": "warning", "body": "Caso você tenha ativado o Bolix em sua conta Gerencianet, as cobranças geradas pelo nosso módulo/plugin já vão vir com o pix no boleto.\nMais detalhes sobre o Bolix e como ativá-lo <a href=\"https://dev.gerencianet.com.br/docs/bolix-boleto-carne\" target=\"_blank\" title=\"Saiba mais sobre o Bolix\">aqui</a>", "title": "Bolix" } [/block] # 1. Requisitos - Versão mínima do PHP: <code>5.4.39</code> - Versão mínima do Boxbilling: <code>4.19</code> <br> <hr> # 2. Instalação 1. Faça o <a href="https://codeload.github.com/gerencianet/gn-api-boxbilling/zip/master" target="_blank" title="Efetuar Download">download da última versão do módulo</a>; 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-boxbilling</code>) e cole no diretório <code>/bb-library/Payment/Adapter/</code> da instalação do Box Billing; 4. Copie a imagem <code>gerencianetcharge.png</code> (disponível no diretório <code>gn-api-boxbilling</code>) e cole no diretório <code>/bb-themes/huraga/assets/img/gateway_logos</code>; 5. No final do arquivo <code>logos.css</code>, localizado no diretório <code>/bb-themes/huraga/assets/css/</code>, cole o seguinte trecho de código: <pre>.logo-gerencianetcharge{ background: transparent url("../img/gateway_logos/gerencianetcharge.png") no-repeat scroll 0% 0%; background-size: contain; width:135px; height: 25px; border: 0; margin: 10px; }</pre> <br> Os arquivos do módulo Gerencianet devem estar com a seguinte estrutura no Box Billing: <pre>/bb-library/Payment/Adapter/ | gerencianet_lib/ | gerencianetcharge.php </pre> <br> ## Configurações do Módulo [block:image] { "images": [ { "image": [ "https://files.readme.io/af10055-parametros_configuracao1.png", "parametros_configuracao[1].png", 1152, 981, "#f7f7f7" ] } ] } [/block] Dentro do painel administrativo do Boxbilling, acesse o menu <code>Configuration > Payment Gateways</code>. Clique para editar as configurações do módulo <code>gerencianetcharge</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 sua aplicação criada, conforme é mostrado <a href="https://gnetbr.com/HylbqtQSz_" 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 sua aplicação criada, conforme é mostrado <a href="https://gnetbr.com/HylbqtQSz_" target="_blank">neste link</a>; **3. Client_Id Homologação:** Deve ser preenchido com o <code>Client_Id</code> de Homologação 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="https://gnetbr.com/SyebXcmBfO" target="_blank">neste link</a>; **4. Client_Secret Homologação:** Deve ser preenchido com o <code>Client_Secret</code> de Homologação 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="https://gnetbr.com/SyebXcmBfO" target="_blank">neste link</a>; **5. Identificador da Conta:** Deve ser preenchido com o identificador de sua conta Gerencianet. Este campo é obrigatório. Confira onde localizá-lo em sua plataforma (<a href="https://cdn.discordapp.com/attachments/652136190006525955/809138574549188618/identificador-conta.jpg" target="_blank">Identificador da Conta</a>); **6. 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; **7. Sandbox:** Caso seja de seu interesse, habilite o ambiente de testes da API Gerencianet; **8. Moeda:** Escolha a opção <code>R$ Real</code> (a mesma deve estar definida no seu Boxbilling); **9. Enabled:** Escolha a opção <code>Yes</code> para ativar o módulo da Gerencianet; **10. Allow one time payments:** Marque a opção <code>Yes</code>; **11. Allow subscription payments:** Marque a opção <code>No</code> (o módulo Gerencianet não suporta transações por assinatura); Por fim, clique em <code>UPDATE</code>. [block:callout] { "type": "danger", "title": "ATENÇÃO", "body": "Importante salientar que **os boletos gerados em sandbox não são válidos e não podem ser pagos**, possuem a linha digitável \"zerada\" e uma marca d'água ao fundo informando ser um boleto de teste.\n\n**Os pagamentos de cobranças de sandbox utilizando cartão de crédito são fictícios, mesmo se utilizar um cartão \"real\".** Todos os pagamentos de cartão neste ambiente terão o pagamento confirmado automaticamente, mas é apenas uma alteração de status para \"Pago\". Este recurso permite que você teste a notificação do status <code>paid</code>.\n\n**Isso significa que todos os pagamentos realizados em sandbox não são reais e, portanto, não há cobrança de nenhuma importância financeira.** \n\nÉ importante saber que as palavras **Playground, Sandbox e Ambiente de Homologação**, 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> # 3. Erros Comuns de Integração 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>".