PrestaShop installation and set-up

Preliminary checks

Before installing and setting up the Addon Payments module for PrestaShop, you need to check some things to make sure it will work properly.

Platform requirements

The Addon Payments PrestaShop module is compatible with the following set-ups:

  • Prestashop, check version here.
  • PHP 7.x with the following extensions installed and enabled:
    • mbstring
    • bcmath or gmp (GNU Multiple Precision)
  • If you use the plugin version 2.0.0, the minimum PHP version is 7.4 and the maximum is 8.3.
  • Web server Apache2 or Nginx.

Compatibility with other set-ups has not been tested. Therefore, we can’t provide support for them.

PHP settings

The module requires the following PHP extensions be installed and enabled:

  • mbstring
  • bcmath or gmp (GNU Multiple Precision)

Since the Addon Payments module is more than 13 MB, you have to change the following parameters in the PHP settings, establishing a minimum value of 20 MB:

  • post_max_size (8 MBs default)
  • upload_max_filesize (2 MBs default)

To change these values, follow these steps:

  1. Find the PHP settings file (php.ini) and open it in your text editor. Where this file is located depends on your platform. You can check the route with the phpinfo() item “Loaded Configuration File”, as explained in the next section.
  2. Find the following items and raise their limit to 20MB (20M) or more:
    • post_max_size
    • upload_max_filesize
  3. To increase their value, enter “20M” or a higher value after the items. 
  4. Save changes and exit the editor.
  5. If you’re using PHP FPM/FastCGI, restart the PHP FPM service. The command for this will depend on the linux/unix distribution and requires administrator permissions. The most probable commands are:
    • “systemctl restart php-fpm“, distributions with systemd.
    • “service php-fpm restart“, distributions with SysVinit. 
    • If you have more than one PHP version installed on the server, we recommend specifying the daemon version to restart. For example “systemctl restart php7.1-fpm“.
  6. Restart service from the web server. The command for this will depend on the linux/unix distribution and web server installed, and requires administrator permissions. The most common are:
    • “systemctl restart apache2“, Apache2 web server.
    • “systemctl restart nginx“, Nginx web server.
  7. Check that the PHP settings changes have been applied correctly. Use the function phpinfo() to do this. 

Check set-up using phpinfo() function

To verify the steps of the PHP set-up, you can use the PHP function phpinfo():

  1. Upload a .php file to your host server with the following code: <?php phpinfo(); ?>
  2. For more reliable information, put the file in the directory with the ecommerce platform (PrestaShop).
  3. Open the route to the file you created for the web server in the web browser.
  4. Then you will see a website with information, such as:
    • PHP Version: Version of PHP installed on the web server.
    • Loaded Configuration File: Route for the PHP settings file on the web server.
    • post_max_size/upload_max_filesize: PHP set-up values.
    • BCMath/GMP/Multibyte: Modules installed and/or enabled (bcmath, gmp, mbstring).
    • $_SERVER[‘SERVER_SOFTWARE’]: Web server and version.

Add secure domain and activate compatibility with modules

Addon Payments requires the domains on the payment gateway to be registered as secure domains in your merchant set-up.
You can set up the secure domains for the corresponding environment (staging/production) on the Addon Payments BackOffice Portal. To do so, follow these steps:

  1. Go into the Addon Payments BackOffice Portal in the corresponding environment (staging/production).
  2. If the set-up is for a sub-merchant, go into it by clicking “Merchant settings” > “Merchant Management” and choose the merchant you need. 
  3. Click “Domain settings”.
  4. Check that the domain the payment gateway is launched from is on the “List of secure domains” you see there.
  5. To add a domain, click on “Add domain” and enter the URL. The URLs entered require only the following elements: (https://), subdomain and domain. Routes, parameters and tags are not necessary. For example:
    • “https://www.mydomain.com/es/shop” just enter: “https://www.mydomain.com”.
    • If operating with subdomains (https://sub.mydomain.com), you will also need to include them as secure domains.
  6. Make sure the box “I’m going to use an ecommerce platform with plugins” is ticked.
  7. Click “Save” to save the changes.
  8. Reload the page on the Addon Payments BackOffice Portal and make sure the changes have been saved.

Addon Payments notification IPs

Check Managing Notifications to know more about notification IPs.

Download, install or update the module

You can download the latest version of the module here. The download will start automatically. Save the file anywhere on your device.

If you’ve already downloaded the module, go into PrestaShop and follow these steps: 

    1. Go to your PrestaShop dashboard.
    2. On the left side menu, click on “Modules” > “Module manager”. 
    3. At the top, click “Upload a module”.

4. Drag and drop the .zip file you downloaded or click “Choose file” and use the file browser to upload it to the platform
5. A window will open showing the module has been installed
6. When finished, you will see a message saying the module has been installed correctly. If the installation was successful, click “Set-up“
7. If there were issues with the installation, check the frequent errors guide.

Go to settings

To get to the module settings:

  1. Go to your PrestaShop dashboard.
  2. On the left side menu, click on “Modules” > “Module manager”.
  3. On the list of the modules, choose “Payment” in the “Category” filter at the top. Select the “Addon Payments” module. If it isn’t there, select “Show all modules” in the “Status” filter.
  4. On the right, click “Set-up” to get to the settings.

Set up the module

These are the options on the settings page and their functions:

  • Production mode: Whether the module is operating in a staging environment or a production environment. To change from one environment the other, you have to enter the “API key” and the “Password” for each environment. 
    • Use staging environment: Disabled.
    • Use production environment: Enabled.
  • Default set-up: Choose which payment method customers see on the gateway.
    • “Multiple payment methods” shows customers all the payment methods available for the product on your merchant.
    • “Customized” shows customers all the payment methods available for the product on your merchant. Plus, you can customize the title and logo for the payment method in the cart.
  • Title: Changes the name customers see for the payment method during checkout.
  • Logo: Shows the logo for the payment method that customers will see during the purchase process.
    • To change the current logo, click “Add file” at the bottom.
    • The file browser will open. Find the new image and upload it to the platform.
    • When you’ve chosen the new image and clicked “Select”, the image will be loaded and shown as the logo for the payment method.
  • Merchant ID: Unique ID for your merchant on Addon Payments. It is provided in the welcome email.
    • It has between 5 and 6 numerical digits.
    • It is the same for both the staging and production environments.
  • API Key: The API key for your merchant on Addon Payments. The format is UUID. For example: “6a18ecb3-bb1e-49cb-b532-264ddc18ed86”.
  • Password: The password for your merchant on Addon Payments. The format is PBKDF2 with HmacSHA256. For example: Odm1hxMXWmkRs9bs3ibrQLs1YUcepvR3JguIzBHt7Sw=. The API key and password are different for the staging environment and the production environment. You have to set them up based on the environment you want to use. 
    • The API key and password for the staging environment come in the welcome email. You can also recover and reset them on the test BackOffice Portal. It is available here. 
    • The API key and password for the production environment aren’t sent by email. You can only recover and reset them on the BackOffice Portal. Find out how in the Going Live guide.
  • Product ID: The product ID created in your merchant on Addon Payments. You’ll find it in the welcome email.
    •  It has between six (6) and ten (10) numerical digits.
    • It may not be the same for both the staging and production environments.
  • Auto-settle all purchases: You can choose from two methods to settle payments during the purchase process: automatic settlement (default) and manual. In manual mode, authorized payments will remain in “Pending” status until you manually order settlement.

The following fields are optional.
They allow you to enter customized URLs to redirect customers after payment. They can be left blank. If they are, the module will redirect the customer to a page on the PrestaShop platform.

  • Success URL: Page customer is sent to if payment is authorized.
  • Cancellation URL: Page customer is sent to if payment is cancelled.
  •  Failure URL: Page customer is sent to if payment is declined.
  • Styles: Allows you to choose the CSS style sheet for the payment gateway to use.

After entering or changing any value, click “Save” on the lower right to save the changes to the module settings.

Quix options

Only apply if you have contracted and activated the Quix instalment payment service from Caixabank Payments &Consumer (CPC). These are the options available:

  • Location of financing banner: Allows you to set where the banner will be seen on the product page. If some of the elements added by other modules are on the same hook, they can be moved in “Design” > “Positions”.
  • Colour of financing banner: The colour that will be used to customize some elements of the banner.
  • Changes to financing banner: Allows you to choose the type of widget to show. The possible values are: “Text banner, Text, Selection, Selection banner”.
  • Set the style for the financing banner: Quix provides this value. This value determines which version of the widget is shown. This includes legal disclaimers and various visual components. It can’t be changed currently.

After entering or changing any value, click “Save” on the lower right to save the changes to the module settings.

Help section

At the top of the module settings, you have a “Help” tab. There you will find: 

  • This installation guide.
  • Guides on searches and managing transactions and refunds.
  • Guides to test different payment methods.
  • Cards for transactions in the staging environment. 

Check the module set-up is correct

At the top of the module settings form you will find a status checker called “Service status”.
When you finish setting up the module, make sure the settings entered work correctly:

  1. If the combination “Environment – Merchant ID – API Key – Password” is correct, the status of the “API web” and “Payment form” will show “Working” with a lightning bolt icon.
  2. If it works, do some test purchases on your platform to confirm. Depending on the environment you used to set up the module:
    • Staging environment: You must use cards for the staging environment, available in Test cards.
    • Production Environment: You can only use real, operational cards. If you process operations in the production environment, you can process the refunds through the Addon Payments BackOffice Portal, available here. 

If any of the fields are wrong or empty, the status will be “Not working” with an exclamation point icon.

Comparte este documento
Tabla de Contenidos

Consulta la documentación de las distintas secciones de integraciones:

Comienza a integrar

undraw_add_to_cart_re_wrdo 1 (1) (1)

Plugins para CMS

Complementa la integración

SDKs

Métodos de pago

Herramientas

Addon Payments

Consulta la documentación de Addon Payments. Aquí tienes las distintas secciones:

Integraciones

Consultas frecuentes

Portal Backoffice

Cyberpac

We are currently working on the English version of the Cyberpac documentation. You can view the Spanish version using the buttons below:

Canales BackOffice Portal

Plugins integration

Custom integrations

POS integrated Payments

Create a solution that will help you automate processes. You can even add payment processes on physical terminals.

Payment Integrated with Android POS

Payment Integrated with Smartphone POS

POS Data sheets

Addon Payments

Comercia Global Payments has several integration options so you can choose the most efficient one for you.

Integrations

Frequently Asked Questions

BackOffice Portal

Consult the documentation of the different integrations sections:​

Start integration

undraw_add_to_cart_re_wrdo 1 (1) (1)

CMS Plugins

Complement your integration

SDKs

Payment Methods

Tools