Joomla (VirtueMart)

Gerencianet Integration Module for Official VirtueMart- Version 0.2.1

The Gerencianet module for Joomla (VirtueMart) allows you to receive payments through the transparent checkout of our API. Compatible with Virtuemart 3 and Joomla! 2.5.

This is the Official Integration Module provided by Gerencianet for VirtueMart. With it, the store owner can choose to receive payments by boleto and/or credit card. The entire process is carried out through the transparent checkout. With this, the buyer does not need to leave the store's website to make the payment.

Some information such as "CPF", "address number", "neighborhood" and "date of birth" may be requested at the time of payment, if the fields are not configured as indicated.

Bolix

If you have activated Bolix in your Gerencianet account, the charges generated by our module/plugin will already come with the pix on the boleto. More details about Bolix and how to activate it, click here.


1. Requirements

  • PHP version: 5.4.0 à 7.0.3
  • Minimal version of VirtueMart: 3.0
  • Minimal version of Joomla!: 2.5

2. Installation

  1. Download the latest version of the plugin;

  2. In your store acess the link Extensions > Manage > Install and send the file gn-api-virtuemart.zip or extract the contents of the file inside the plugins directory of the store;

  3. Configure the plugin as instructed below and start receiving payments with Gerencianet.


3. Settings

  1. First, create your free Gerencianet account;

2.Create 3 extra fields in Virtuemart: numero //number, bairro //neighborhood and data_nascimento //birth date. The house number, neighborhood and date of birth are mandatory data for payment by credit card. If it is not informed in the registration form or in the cart, it will be requested at the time of payment;

  1. Enable the plugin in Administrar Plugins;

  2. Install our plugin through the screen Métodos de pagamento;

  3. Click in Novo Método de Pagamento and fill in the following information:

  • Nome do Pagamento: Cartões de crédito ou Boleto Bancário ( Gerencianet );
  • Publicado: Sim;
  • Descrição do pagamento: Pague com Cartão de Crédito ou Boleto Bancário;
  • Método de pagamento: Gerencianet;
  • Grupo de Compradores: -default-

  1. Click in Salvar;

  2. In the tab Configurações, fill in the following information:


Payment Plugin Settings

  • Modo de teste: Sim ou Não;
  • Client ID Desenvolvimento: em sua conta Gerencianet, acesse API > Minhas Aplicações, selecione sua aplicação e clique na aba Desenvolvimento;
  • Client Secret Desenvolvimento Conta Gerencianet > API > Aplicações > Sua Aplicação > Client Secret Desenvolvimento
  • Client ID Produção Conta Gerencianet > API > Aplicações > Sua Aplicação > Client ID Produção
  • Client Secret Produção Conta Gerencianet > API > Aplicações > Sua Aplicação > Client Secret Produção As credenciais devem ser da sua Aplicação na Gerencianet. Para criar uma nova Aplicação, entre em sua conta Gerencianet, acesse o menu "API" e clique em "Minhas Aplicações" -> "Nova aplicação".
Observação:

Para criar sua aplicação, logue em sua conta Gerencianet, acesse o menu superior "API", depois clique em "Minhas Aplicações > Nova Aplicação" e defina um nome para a sua aplicação.


Campos Extras Obrigatórios

  • Campo Logradouro (do endereço)
  • Campo Bairro
  • Campo Número (do endereço)
  • Campo Complemento (do endereço)
  • Campo Telefone (do cliente)
  • Campo CPF (do cliente)
  • Campo Data de Nascimento (do cliente)

Configurações do Boleto Bancário

  • Dias para vencimento
  • Desconto para pagamento no Boleto

Recomendamos que antes de disponibilizar pagamentos pela Gerencianet, o lojista realize testes de cobrança com o sandbox (ambiente de testes) ativado para verificar se o procedimento de pagamento está acontecendo conforme esperado.

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



4. 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".