WooCommerce installation and set-up

Welcome to the Addon Payments plugin for WooCommerce. This plugin is designed to improve the payment processing capacities of your WooCommerce online shop, giving your customers a secure payment experience. By integrating this payment into your WooCommerce, you will unlock a series of advanced functions and streamline payment processes.

This guide will take you through the whole process of installing, setting up and optimizing the plugin for WooCommerce. Whether you are a new or experienced user, this guide will help you make the most of what the plugin has to offer. 

We’ll start with some preliminary tests to make sure the installation doesn’t run into problems. Then, we’ll look at the installation process step by step: download and activation of the plugin on the WordPress administration dashboard. Finally, we will explore the set-up options.

Preliminary checks

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

Platform requirements

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

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

PHP settings

The module requires at least one of the following PHP extensions be installed and enabled:

  • 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 (WordPress).
        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: Modules installed and/or enabled.
          • $_SERVER[‘SERVER_SOFTWARE’]: Web server and version.

          Add secure domain and activate compatibility with modules

          The modules (PrestaShop, WooCommerce, Magento or Salesforce) operate through JavaScript integration. For this type of integration, Addon Payments requires the domains involved in 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 “Merchant settings“ > “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. If the integration is through a module, tick the box “I’m going to use ecommerce platforms with plugins”.
          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 Addon Payments module for free on the following link. When you click, the module will start downloading. Save the file anywhere on your device. 

              Regardless of the installation method you choose, make sure the Addon Payments plugin is installed in the directory “wp-content/plugins” of your WordPress. Once it is installed, you can activate the plugin on the WordPress dashboard using the corresponding activation steps for each method.

              Install the module via WordPress

              If you’ve already downloaded the module, follow these steps:

              1. Go to your WordPress dashboard.
              2. On the left side menu, click on “Plugins” > “Add new”.
              3. Click on “Upload plugin” at the upper left.
              4. Drag and drop the .zip file you downloaded. You can also use the button “Find” or “Choose file” and use the file browser to upload it to the platform. You will see the name of the file you selected and the button “Install now”.
              5. Click “Install now”. The module will be uploaded to the WordPress platform and installed.
              6. After a few seconds, you will see a message telling you whether the module has been installed correctly or there were any errors.
                If there were any errors, check the frequently asked questions guide.
              7. If the module has been installed correctly, click “Activate plugin”. The module will be activated and you will see “Addon Payments” on the list of payment methods on WooCommerce.

              Install the module via FTP

              1. Go to the server for your website using an FTP client (for example, FileZilla).
              2. Go to the directory “wp-content/plugins” on your server.
              3. Extract the content from the zip you downloaded in a folder.
              4. Upload the folder with the extracted plugin to the directory “wp-content/plugins” on your server.

              Activate the plugin:

              1. After the plugin files have been uploaded to the directory “wp-content/plugins“, go back to the WordPress dashboard.
              2. On the menu at the left, click “Plugins”.
              3. Find the Addon Payments plugin on the list of plugins installed.
              4. Click “Activate” under the plugin name.

              The Addon Payments plugin will be activated and you will see “Addon Payments” on the list of payment methods on WooCommerce.

              Install the module via the cPanel file manager.

              1. Go to the cPanel dashboard on your website.
              2. Find and open the “File manager” tool.
              3. Go to the directory “wp-content/plugins”.
              4. Upload the zip file you downloaded to the directory “wp-content/plugins”. You can drag and drop the file or use the “Upload” button.

              Activate the plugin:

              1. After the plugin file has been uploaded to the directory “wp-content/plugins“, go back to the WordPress dashboard.
              2. On the menu at the left, click “Plugins”.
              3. Find the Addon Payments plugin on the list of plugins installed.
              4. Click “Activate” under the plugin name.

              The Addon Payments plugin will be activated and you will see “Addon Payments” on the list of payment methods on WooCommerce.

              Go to settings

              To get to the module settings, follow these steps:

              1. Go to your WordPress dashboard.
              2. On the left side menu, click on “WooCommerce” > “Settings”.
              3. Click on the tab “Payments” on the top. “Addon Payments” should be on the list of payment methods.
              4. Click on “Finish Set-up” on the right to get to the module settings.

              Set up the module

              On the module settings page, you’ll see the following options:

              • Activate/Deactivate: Whether the Addon Payments payment method is active. If it is active, customers will see this option during the purchase process. If it is deactivated, customers won’t see it.
              • 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: The box must be ticked.
                • Use production environment: Box mustn’t be ticked.
              • 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: Change the name of the payment method. Customers will see this name during the purchase process.
                • It can be changed if you choose “Customized” in “Default settings”.
              • Logo: Shows the logo for the payment method that customers will see during the purchase process. It can be changed if you choose “Customized” in “Default settings”. To change it, follow these steps:
                1. Click “Choose file” below the logo URL.
                2. This will open the file browser. Choose a new image.
                3. Click “Select”. The image will be shown as a logo.
              • Merchant ID: ID for your merchant on Addon Payments. It is provided by Support in the welcome email.
                • It has between five (5) and six (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 is in PBKDF2 with HmacSHA256 format, where the merchantId is used as the salt and 10,000 iterations are applied. For example:
                • merchantId and Salt: 2150100
                • Raw password: NewPassword123!
                • Iterations: 10,000
                • Result: 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.
                • 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.
                • Automatic settlement: 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. If you leave them blank, the module will redirect customers to a WordPress platform page.

                • Success URL: Page customer is sent to if payment is authorized.
                • Failure URL: Page customer is sent to if payment is declined.
                • Cancellation URL: Page customer is sent to if payment is cancelled.

                After entering or changing any value, click “Save changes” on the lower left 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.
              • 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 changes” on the lower right to save the changes to the module settings.

                Help section

                To get to the help section of the Addon Payments module, follow these steps: 

                1. Go to the plugins installed on WordPress from the menu on the left.
                2. Look for the Addon Payments module row.
                3. Under the name, you’ll see the link marked “Help”. Click on it.

                When you click, you’ll see the following information: 

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

                  User experience after setting up and activating the plugin

                  After you set up and activate the plugin for the WooCommerce payment gateway, you can start accepting payments on your online shop. This section describes the user flow and steps of the payment process:

                  1. Customer chooses products: The customer visits your online shop and browses the products or services you offer. They choose the items they want to buy and go to the payment page.
                  2. Payment page: On the payment page, the customer enters their billing and shipping details, as well as any additional information required for the purchase. They check their order and move on to the payment section.
                  3. Payment method selection: In the payment section, the customer sees the Addon Payments payment options. These options are provided by the Addon Payments plugin you set up. The customer fills in the form with their card details.
                  4. Payment processing: The customer places their order. The payment gateway plugin securely sends the information and redirects the user to the payment processor.
                  5. Payment authorization: The payment processor verifies the customer’s payment details, including card validity or other payment instrument. This step ensures the customer has sufficient funds or credit available to cover the transaction.
                  6. Transaction result: After the payment processor completes the authorization process, it sends the result to your WooCommerce shop. The result may be a successful transaction or failed transaction for several reasons, such as insufficient funds or invalid payment method.
                  7. Order confirmation: Depending on the transaction result, your WooCommerce shop shows the customer the corresponding message. If the payment is a success, the customer receives an order confirmation and their order is processed. For a failed payment, the customer is notified and encouraged to try an alternative payment method.
                  8. Order fulfilment: After a successful payment, your shop proceeds to fill the order, which may involve actions like inventory management, generating shipping labels and sending the customer notifications on the status of their order.
                  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