PrestaShop

Gerencianet Integration Module for PrestaShop - Version 0.3.1

The Gerencianet module for Prestashop allows you to receive payments through the transparent checkout of our API. Compatible with PrestaShop's 1.6.x version.

This is the Integration Module provided by Gerencianet for PrestaShop. With it, the store owner can choose to receive payments by bank slip 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.

Bolix

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


1. Requisitos

  • PHP version: 5.4.39 to 7.0.3
  • PrestaShop version: 1.6.x
IMPORTANT

The system requirements were defined according to our tests. If your system doesn't meet the requirements, it doesn't mean that the module won't work in your PrestaShop, but that we don't test it in the same environment. Therefore, we do not guarantee the operation of this module in environments other than those mentioned above.


2. Module Installation

The Gerencianet module for PrestaShop can be installed in two different ways:

  1. Automatic Installation: using the module installation file packaged through the PrestaShop Add New Modules tool;

  2. Manual Installation:module files must be manually uploaded to the hosting server via FTP.


Automatic Installation

  1. Download the latest version of the module (file "gerencianet.zip");

  2. Access the administration panel of your store, then access Módulos > Adicione um novo Módulo and send the file "gerencianet.zip" just downloaded in the first step;

  3. After sending the module to your store, click on Instalar and wait for the process to complete.

alt text

  1. Configure it in Módulos > Gerencianet > Configurar and start receiving payments.

Manual Installation

  1. Download the latest version of the module (file "gerencianet.zip") and extract its content or download of the last unzipped version (folder /manual);

  2. Access the store via FTP and upload the entire gerencianet unzipped flder to the destination folder modules which is at the root of the store files on the server;

  3. Go to the store administration and access Módulos. Look for the Gerencianet module in the list, click in Instalar and wait until the process is finished;

  4. Configure the module in Módulos > Gerencianet > Configurar and start receiving payments.


3. Gerencianet's Plugin Settings for PrestaShop

To configure the Gerencianet Module for Prestashop, the merchant must access the administrative interface of the virtual store and, in the main menu, access the Modules option. Look for the Gerencianet module in the list that will be displayed and then click on Configure, as shown in the image below:

alt text


When entering module configuration, the following interface will be displayed:

alt text

The credentials and preferences must be configured through the two available tabs:


General Settings

alt text

On this tab, the following properties can be configured:

  1. Modo (mode): Configure if you want to activate the development module (testing environment) or production (real billing);

  2. Opções de Pagamento (payments options): Configure the payment options you want to receive: Boleto and/or Credit Card.

  3. Dias para vencimento do Boleto (Boleto expiration days): Configure the number of calendar days for the Boleto to expire.

  4. Desconto para pagamento no boleto(%) (Boleto's payment discount(%)): Define if you want to apply a discount for payments with Boleto.

  5. Atualizar status dos pedidos PrestaShop automaticamente: Configure if you want the module to update the status of the store orders automatically according to the Gerencianet notifications.

  6. Status: Configure whether the Module will be available to clients.


Credentials

In this tab it is necessary to inform the credentials of your application, that is, the "Client_Id" and "Client_Secret" (see where to find it, according to the environment: development and production)of your application and the account identifier obtained in the application created in Gerencianet.

  1. The shopkeeper shall insert the management credentials manage in their fields. To access these credentials, you must create a new managem application or use an existing one. To create an application, enter your management account, go toAPI > Minhas Aplicações > Nova aplicação. Choose a name and create the new application. It will now have access to the application credentials. Copy them and enter the respective fields in the "credentials" tab in your store (client_id and client_secret of production and development).

  2. Insert the account identifier Gerencianet.

  3. Click in Salvar and now your virtual store is ready to receive payments through Gerencianet.


IMPORTANT

When in production environment, use the Client_Id and Client_Secret from the "Production" tab and the sandbox option disabled. If it's under development, use the Client_Id and Client_Secret from the "Development" tab with the sandbox option enabled. If not done this way, a possible "unauthorized" message may be returned.


CAUTION

It is important to note that boletos generated in sandbox are not valid and cannot be paid, they have the typeable line "zero" and a watermark at the bottom stating that it is a test ticket.

Payments for sandbox charges using credit card are dummy even if using a "real" card. All card payments in this environment will have the payment confirmed automatically, but this is just a status change to "Paid" . This feature allows you to test the paid status notification.

This means that all payments made in the sandbox are not real and, therefore, there is no financial charge.

It is important to know that the words Playground, Sandbox and Development Environment, in the Gerencianet context, are synonymous in the sense that they refer to the test site we offer where you can freely test your API integration.


4. Module Operation

After being enabled, the module will already be available as a payment option.

Depending on whether you enable or disable the Payment in one step option, the page where the customer will enter their payment details will be different.

If the One-step payment option is active, your customer will fill in the payment details on the same Checkout screen, as shown in the figures below:

alt text

alt text

In this way, when clicking on Checkout, the customer's data will be validated and, if everything is correct, the charge will be generated and the purchase completed. The customer is then redirected to the finalized purchase page.

If the One-step payment option is not active, your customer will fill in the personal and delivery details on the Checkout page and by clicking on Confirm Order will be redirected to another page to proceed with the payment, where you will choose the Gerencianet payment option, as shown below:

alt text

Both payment screens may change depending on the theme used in the store.

NOTE

If any of the mandatory fields for making the payment is not filled in correctly, it will be charged again in the payment form. For Boleto Bancário, the mandatory fields are: Name, E-mail, CPF and phone number. For Credit Card, the mandatory fields are:: Name, E-mail, CPF, date of birth, Phone, Address, Number, Neighborhood, Zip Code, City and State.


5. Fequently asked questions

5.1. Is it mandatory to have SSL in my store to accept payments with the module?

For the Gerencianet module for PrestaShop to work, it is not necessary for the store to have an SSL certificate. However, it is highly recommended by Gerencianet to use it. Regardless of its use, all payment data is encrypted and transmitted securely for payment validation. The presence of an SSL certificate installed in your store guarantees greater security for the shopkeeper and for customers who make purchases. The absence of the SSL certificate on the payment screen can cause the merchant to lose sales, as the customer may feel insecure to enter payment data on a page that does not have a certificate.


5.2. I want to use Transparent Checkout so that the customer does not leave my store to make the payment. It's possible?

Yes. The Gerencianet module for PrestaShop uses the transparent checkout to pay customers, that is, at no time will the customer leave your virtual store to complete the payment. Thus, in the last step of the purchase, the customer will be asked for the mandatory data to make the payment.

5.3. Is it possible to use the marketplace or signatures features with the module?

Not yet. Follow our Changelog to view all news.


5.4. Payment option installments are not loading. How to fix it?

If, after installing and configuring the module, the credit card installments do not load when clicking on the card brands, the merchant must verify the credentials informed in the module configuration (Client_Id, Client_Secret keys and also the "account identifier"). If they are correct, contact the Gerencianet so that the problem can be analyzed.


5.5. I'm getting the message "Unauthorized" when trying to complete a purchase. What to do?

This error message may be related to incorrectly entered credentials. Check that your credentials are correctly entered in the respective PRODUCTION and DEVELOPMENT fields. Check more details in our FAQ.


5.6. The message “Management Disabled: Sandbox mode (Test environment) is active. Your charges will not be validated”. How to fix?

This message will be displayed when your module is configured in a test environment (sandbox). To remove this message and start receiving with Gestoret, access the module settings in "Módulos" > "Gerencianet" > "Configurar" and uncheck the option “SandBox” > “Habilitar Sandbox Gerencianet (Ambiente de testes)”.


5.7. Where can I follow the transactions generated by the module?

Transactions generated through the module can be accompanied in your management account in the “API” > “Minhas Aplicações” > “Your Aplicação”. In this environment you can track all transactions and their respective situations.

5.8. When I try to make a payment I get the message "An error occurred while trying to make your request. Contact your owner of the store. "

This error message can be displayed at the time of completing purchase by several factors. In this case, the first step is to check the credentials of your application and also check in your API to subbtab "histórico de requisições" See How to Use This Resource)


6. Support and Suggestions

Your suggestion of new ideas and implementations for the Gerencianet module for PrestaShop is very important. So, if you have any ideas, please contact our team. We will analyze your suggestion and evaluate the possibility of implementation.

If you have any questions, please contact us via the website. Gerencianet.