Pular para o conteúdo principal

Box Billing

Módulo de Integração Efí para Boxbilling Oficial - Versão 0.2.1 (Beta)


O módulo Efí 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 Efí 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 Efí envia uma notificação automática para o Boxbilling.

Caso você tenha alguma dúvida ou sugestão, entre em contato conosco pelo site Efí.


1. Requisitos​

  • Versão do PHP: 5.4.39 à 7.0.3
  • Versão mínima do Boxbilling: 4.19

2. 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-boxbilling) e cole no diretório /bb-library/Payment/Adapter/ da instalação do Box Billing;

  4. Copie a imagem gerencianetcharge.png (disponível no diretório gn-api-boxbilling) e cole no diretório /bb-themes/huraga/assets/img/gateway_logos;

  5. No final do arquivo logos.css, localizado no diretório /bb-themes/huraga/assets/css/, cole o seguinte trecho de código:

.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;
}

Os arquivos do módulo Efí devem estar com a seguinte estrutura no Box Billing:

/bb-library/Payment/Adapter/
  |  gerencianet_lib/
  |  gerencianetcharge.php

Configurações do Módulo​

alt text

Dentro do painel administrativo do Boxbilling, acesse o menu Configuration > Payment Gateways. Clique para editar as configurações do módulo gerencianetcharge. 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 Efí. Este campo é obrigatório e pode ser encontrado no menu API > Minhas Aplicações. Em seguida, selecione sua aplicação criada, conforme é mostrado neste link;

2. Client_Secret Produção: Deve ser preenchido com o Client_Secret de produção de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu API > Minhas Aplicações. Em seguida, selecione sua aplicação criada, conforme é mostrado neste link;

3. Client_Id Homologação: Deve ser preenchido com o Client_Id de Homologação de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu API > Minhas Aplicações. Em seguida, selecione sua aplicação criada, conforme é mostrado neste link;

4. Client_Secret Homologação: Deve ser preenchido com o Client_Secret de Homologação de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu API > Minhas Aplicações. Em seguida, selecione sua aplicação criada, conforme é mostrado neste link;

5. Identificador de conta: Deve ser preenchido com o identificador de sua conta Efí. Este campo é obrigatório. Confira onde localizá-lo em sua plataforma (Identificador de conta);

6. E-mail de cobrança - Efí: Caso seja de seu interesse, habilite o envio de emails de cobrança da Efí para o cliente final;

7. Sandbox: Caso seja de seu interesse, habilite o ambiente de testes da API Efí;

8. Moeda: Escolha a opção R$ Real (a mesma deve estar definida no seu Boxbilling);

9. Enabled: Escolha a opção Yes para ativar o módulo da Efí;

10. Allow one time payments: Marque a opção Yes;

11. Allow subscription payments: Marque a opção No (o módulo Efí não suporta transações por assinatura);

Por fim, clique em UPDATE.

Atenção!

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.

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 paid.

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.

É importante saber que as palavras Playground, Sandbox e Ambiente de Homologação, no contexto da Efí, 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.



3. Erros Comuns de Integração​

Ainda que nenhum destes erros de validação sejam retornados, a API Efí 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 interpretando erros da API.

Última atualização em