Skip to main content

PrestaShop

Efí Integration Module for PrestaShop - Version 1.0.2


The Efí module for Prestashop allows receiving payments through the transparent checkout of our API. Compatible with PrestaShop version 8.1.x.

This is the integration module provided by Efí 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 transparent checkout, so the buyer does not need to leave the store site to make the payment.


1. Requirements​

  • PHP Version: 8.1.x
  • PrestaShop Version: 8.1.x
Important!

The system requirements were defined according to our tests. If your system does not meet the requirements, it does not mean that the module will not work on your PrestaShop, but rather that we have not tested it in that environment. Therefore, we do not guarantee the functionality of this module in environments other than those mentioned above.



2. Module Installation​

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

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

Automatic Installation​

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

  2. Access your store administration, go to Modules > Module Manager > Upload a Module and upload the file "EfiPayPrestashop.zip" that you just downloaded;

    banner

    Upload the module

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

    banner

    Module installed


3. Efí Plugin Configuration for PrestaShop​

To configure the Efí Module for PrestaShop, clicking on Configure in the previous step will automatically redirect you to the configuration screen. Alternatively, the store owner should access the store's administrative interface and, from the main menu, go to Modules > Module Manager. Look for the Efí module in the list that appears and then click on Configure, as shown in the image below:

banner

Plugin Configuration

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

banner

Efí Plugin Interface


Credentials​

banner

Credentials and Environment Settings

In this section, you need to provide your application credentials, namely the "Client_Id" and "Client_Secret" (see where to locate them according to the environment: sandbox and production) and the account identifier obtained from the application created on Efí.

  1. The store owner must enter the Efí application credentials in the respective fields. To access these credentials, you need to create a new Efí application or use an existing one. To create an application, log in to your Efí account and go to API > My Applications > New Application. Choose a name and create the new application. You will now have access to the application credentials. Copy them and enter them in the respective fields under the "Credentials" tab in your store (Client_Id and Client_Secret for production and sandbox).

  2. Enter the Efí account identifier.

Attention!

It is important to note that boletos generated in sandbox are not valid and cannot be paid, they have a "zeroed" digitable line and a watermark in the background indicating that it is a test boleto.

Payments for sandbox charges using credit cards are fictitious, 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 sandbox are not real, and therefore, no financial amount is charged.

It is important to know that the words Playground, Sandbox, and sandbox Environment, in the context of Efí, are synonyms referring to the testing environment we offer where you can freely test your integration with the API.


In this section, you should also configure the following properties:

  1. Issuance Environment: Configure whether you want to activate the module in Homologation (testing environment) or Production (real charges);

  2. Payment Methods: Select the payment options you want to receive: Boleto, Credit Card, and/or Pix.

By clicking on Save, you will be able to configure the selected payment methods. The following sections will then appear:

Billet Settings​

banner

Boleto Settings

In this section, you can configure the following properties:

  1. Number of days: Set the number of calendar days until the Boleto due date.

  2. Cancel unpaid Boletos?: When enabled, it cancels all unpaid Boletos, preventing the customer from paying the Boleto after the due date.

  3. Enable discount?: When enabled, a discount will be applied for payments made with Boleto.

  4. Boleto discount percentage: Set the discount percentage for payments made with Boleto.

  5. Penalty percentage: Define if you want to apply a penalty for late payment of the Boleto.

  6. Interest percentage: Define if you want to apply interest for late payment of the Boleto.

  7. Send Boleto by email?: When enabled, the Boleto will be sent to the customer by email.


Pix Settings​

banner

Pix Settings

  1. Pix Key: Enter your Pix key registered with Efí. If you haven't registered it yet, see our article on How to register Pix keys on Efí.
Pix Key

If your Pix key is registered as a phone number, remember to follow the standard defined by BACEN by including +55 DDD and the number, for example: +5531988887777


  1. Pix Certificate: Upload the certificate in .p12 format, generated from your Efí Account. If you haven't generated it yet, see our article on How to generate a certificate.
Pix Certificate

After uploading your Pix certificate, it will be saved, but the certificate name will not be visible. If there is an error, you will receive a notification when saving the settings.

  1. Enable discount?: When enabled, a discount will be applied for payments made with Pix.

  2. Pix discount percentage: Set the discount percentage for payments made with Pix.

  3. Expiration time in hours: Set the expiration time in hours for the Pix after issuance.

  4. Validate mTLS: Check the "Validate mTLS" field if you want to use mTLS validation on your server.


Open Finance Settings​

banner

Open Finance Settings

  1. Name: Enter the name of the Efí account holder.

  2. Document: Enter the CPF/CNPJ of the Efí account holder.

  3. Agency: Enter the agency number of the Efí account.

  4. Account: Enter the Efí account number.

  5. Account type: Choose from the available options according to your account type.

Notes

You need to configure the certificate in the Pix menu, and if you want to offer any discount in Open Finance, you can configure it in the Pix menu.


4. Module Operation​

After being enabled, the module will be available as a payment option, and your customer will have the following screens to fill in the payment details:

Billet:

banner

Billet Payment Screen

Credit Card:

banner

Credit Card Payment Screen

Pix:

banner

Pix Payment Screen

Open Finance:

banner

Open Finance Payment Screen

Note

If any of the required fields for payment are not correctly filled or left blank, the customer will receive an alert. For Boleto Bancário, the required fields are: Name and CPF. For Credit Card, the required fields are: Name, CPF, Date of Birth, Phone, Address, Number, Neighborhood, Postal Code, City, and State. For Pix, the required fields are: Name and CPF. For Open Finance, the required fields are: CPF and Financial Institution.


5. Frequently Asked Questions​

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

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


I want to use Transparent Checkout so that the customer does not leave my store to make the payment. Is it possible?​

Yes. The Efí module for PrestaShop uses transparent checkout to process customer payments, meaning the customer will never leave your online store to complete the payment. Thus, in the final step of the purchase, the required payment details will be requested from the customer.


The installment options for payments are not loading. How to fix this?​

If after installing and configuring the module the credit card installments do not load when clicking on the card brands, the merchant should check the credentials entered in the module configuration (Client_Id, Client_Secret keys, and also the "account identifier"). If they are correct, contact Efí for further analysis.


I am receiving the message “Unauthorized” when trying to complete a purchase. What to do?​

This error message may be related to incorrectly entered credentials. Check if your credentials are correctly entered in the respective PRODUCTION and DEVELOPMENT fields. Check our FAQ for detailed information.


I am seeing the message “Efí Disabled: Sandbox mode (test environment) is active. Your charges will not be validated”. How to fix this?​

This message will be displayed when your module is configured in the test environment (sandbox). To remove this message and start receiving payments with Efí, access the module settings in "Modules" > "Efí" > "Configure" and uncheck the option "SandBox" > "Enable Efí Sandbox (test environment)".


Where can I track the transactions generated by the module?​

The transactions generated through the module can be tracked in your Efí account under "API" > "My Applications" > "Your Application". In this environment, you can monitor all transactions and their respective statuses.

When I try to make a payment, I receive the message “An error occurred while trying to process your request. Contact the store owner.”​

This error message may be displayed during the checkout process for various reasons. In this case, the first step is to verify your application's credentials and also check the "request history" sub-tab in your API to see how to use this feature.


6. Support and Suggestions​

Your suggestions for new ideas and implementations for the Efí module for PrestaShop are very important. Therefore, 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 Efí website.

Last updated on