Magento installation and set-up

Preliminary checks

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

Platform requirements

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

  • Magento, check version here.
  • PHP 7.X – 8.1.
  • Composer.
  • Console access to the web server (SSH or similar) with the permissions necessary to change the Magento root directory.

For installations on GNU/Linux servers, to avoid problems with permissions during installation and execution of Magento and the module, we recommend you consider the following points:

  • Check that the user created in the SO for the web server service (normally www-data) has read, write and execute permissions for the Magento root directory.
  • Install both the CRM and the module using the users created in the SO for the web server service (normally www-data).
    • To do so, use the command “sudo -u www-data command“, which will execute the command with the user of the web server service.
  • The commands in this guide are for reference only and are executed from the Magento root directory.

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

Module version Magento PHP 7.x PHP 8.X
1.4.12.4.3 ✅ ❌
2.4.4 ✅ ✅
2.4.5 ✅ ✅
2.4.6 ❌ ❌

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

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

Go to Notification management for more information on notification IPs. 

Installation

Setting up the repository

Using the console, find the “composer.json” file in the Magento root directory.

Then add Addon Payments to the list of repositories.

To speed up the process and avoid any set-up errors, you can add the repositories with the following commands:

sudo -u www-data composer config repositories.addon-payments-module git https://bitbucket.org/easypaymentgateway/public-magento.git

sudo -u www-data composer config repositories.addon-payments-sdk git https://bitbucket.org/easypaymentgateway/addon-payments-sdk.git

The “repositories” section of the file should look something like this:

				
					"repositories": { 
    "repo": { 
        "type": "composer", 
        "url": "https://repo.magento.com/" 
    }, 
    "addon-payments-module": { 
        "type": "git", 
        "url": "https://bitbucket.org/easypaymentgateway/public-magento.git" 
    }, 
    "addon-payments-sdk": { 
        "type": "git", 
        "url": "https://bitbucket.org/easypaymentgateway/addon-payments-sdk.git" 
    }
},

Download and install the module and extensions

After adding the Addon Payments repositories to the “composer.json” file, execute the command:

sudo -u www-data composer require comercia-global-payments/module-addon-payments

This command executes the following actions:

  1. Searches for the most recent version of the module with the name indicated in all the repositories set up in the “composer.json” file.
  2. Adds the Addon Payments module found to the requirements indicated in the “composer.json” file.
  3. Download and install the following packages:
    • The module.
    • The right SDK for the PHP version installed on the web server.
      • PHP 7.x: SDK 1.x
      • PHP 8.x: SDK 2.x
    • The required extensions.

    Update Magento settings

    1. After downloading and installing the module using the command above, update the Magento settings with this command:
      sudo -u www-data php bin/magento setup:upgrade
    2. Then empty the Magento caches with the command:
      sudo -u www-data php bin/magento cache:clean
    If the module has been installed correctly, you will see the Addon Payments settings section at:

    1. “Shops”
    2. “Set-up”

    3. “Sales”.
    4. “Payment methods”.
    5. “Other payment methods”
    6. “Settings” in the Addon Payments section.

    Module settings

    After clicking “Set up”, you will see options to adjust how the module works. Next to each option it shows whether it is required:

    • Enable Addon Payments (required): Enables and disables the payment method on the CRM. It must be “Yes” (enabled) for customers to see the payment option.
    • Title: Customizes the text for the payment method that customers see during the payment process.
    • Icon: Customizes the icon for the payment method that customers see during the payment process.
    • Icon width and height: Customizes the size of the payment method icon.
    • Payment action: Chooses whether customer payments are captured automatically or manually.
      • Charge: Automatic settlement (default). You don’t have to do anything here. The amount will be settled when payment is completed.
      • Pre-Authorization: Manual settlement. The amount won’t be settled automatically. Settlement must be ordered from the CRM BackOffice Portal or the Addon Payments BackOffice Portal. You have seven (7) calendar days to order settlement.

    Below you have the credentials. These are provided by the Addon Payments support team during registration. They are all required. 

    • Merchant ID (required): Your merchant ID.
    • Product ID (required): The product ID created in your merchant.
    • Merchant Key (required): Password for connection to JS cashier.
    • Merchant Secret (required): Password to encrypt messages.
    • Sandbox (required): Shows whether the module will send requests to the staging environment (Yes) or the production environment (No).

    The following section is for 3D Secure:

    • Enabled (required): Set up whether the payment requests are managed through a secure merchant (Default is Yes) or a non-secure merchant (No).
      • To comply with the European electronic payments regulation PS2, if you are going to receive payment from customers residing in the European Economic Area (EEA), the value must be “Yes”.

      Finally, click “Save settings” on the lower right.

              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:

              • Types of financing: Set up how financing is offered to customers placing orders between the established minimum and maximum amounts.
                • If you have contracted the “Quix” financing product, choose payment in instalments (allows customers to pay for their order in up to 12 months).
                • Payment in instalments: Obsolete option to split payment into instalments. Don’t choose it.
              • Financing banner
                • Enable in product view: Enable the banner with information about financing on the product page.
                • Enable in cart view: Enable the banner with information about financing on the product page.
              • Product View Configuration and Cart View Configuration: Allows you to customize the banners shown on the product page and the cart summary, respectively.

              After you’ve made the corresponding changes, click “Save settings” on the lower right.

              Updating the module

              To update the module already installed on your CRM, follow these steps:

              1. Execute the command in the Magento root directory to search for and download updated versions of the modules installed in the repositories you have set up. If there is a module with a version higher than the one on your CRM, Composer will download it to be installed:
                sudo -u www-data composer update
              2. Execute the command to update the Magento settings:
                sudo -u www-data php bin/magento setup:upgrade
              3. Empty the Magento caches with the command:
                sudo -u www-data php bin/magento cache:clean

              If all the steps were executed correctly, your CRM will have the latest version of the module with the same set-up.

              Uninstalling the module

              To remove the Addon Payments module from your CRM, follow these steps:

              1. Using the console, find the “composer.json” file in the Magento root directory.
              2. Edit the file. In the “require” section, find the line with “comercia-global-payments/module-addon-payments” and delete it.
                • Optional: You can also remove the Addon Payments repository from the repositories list. 
              3. Execute the command in the Magento root directory to uninstall and delete the module and its extensions:
                sudo -u www-data composer update
              4. Execute the command to update the Magento settings:
                sudo -u www-data php bin/magento setup:upgrade
              5. Empty the Magento caches with the command:
                sudo -u www-data php bin/magento cache:clean
              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