Common mistakes with Magento installation and set-up

Preliminary checks

Before starting to use the Addon Payments module for Magento, you need to check some things and comply with some requirements.

Verify module compatibility

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

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

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

    Compile information using the phpinfo() function

    For some errors it is necessary to verify settings and information for your platform, to correctly locate the root cause. Some points to check include:

    • Magento version.
    • Version of the module to be installed.
    • Web server (Apache2/Nginx).
    • PHP version installed.
    • PHP modules installed and/or enabled.
    • PHP configurations applied.

    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 (Magento).
    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.
      • Core: PHP set-up values.
      • iconv/intl/json/libxml: Modules installed and/or enabled.
      • $_SERVER[‘SERVER_SOFTWARE’]: Web server and version.

    Addon Payments notification IPs

    Go to Notification management for more information on notification IPs.

    Errors installing the module

    Possible cause:

    The file “composer.json” in the working directory doesn’t have the module repository.

    Solution:

    Check that the Addon Payments repositories have been correctly added to the “composer.json” file in the working directory so Composer can find and download the module. 

    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

    Extension errors

    Possible cause:

    The file “composer.json” in the working directory doesn’t have the SDK repository for the module.

    Solution:

    Check that the Addon Payments repositories have been correctly added to the “composer.json” file in the working directory so Composer can find and download the module.

    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

    Possible cause:

    The Addon Payments module, the Addon Payments SDK or an extension version [x] requires a developer extension version of [y] or higher, which is not installed. Plus, Composer can’t install it for one of the following reasons:

    • No compatible lowest or highest version found:
    • Compatible version found by the extension is already installed and blocked for a specific version.

    Possible solutions:

    • No compatible lowest or highest version found:
      • Check that the Magento repository is correctly set up in Composer.
      • Wipe the Composer cache.
    • Compatible version found by the extension is already installed and blocked for a specific version.
      • You can force installation of a lower or higher version of the extension than the one installed using this command, with [z] being the version to install:
        sudo -u www-data composer require [developer]/[extension]:[z]
      • Example: The “theorchard/monolog-cascade” extension requires its own extension, “symfony/options-resolver”, in a version between 2.7.0 and 5.4.21. However, the platform has “symfony/options-resolver” version 6.3.0 installed. The incident can be resolved with the following sample command. This command forces Composer to install the highest version supported by the module “5.4.21”:
        sudo -u www-data composer require symfony/options-resolver:5.4.21

    Error in showing the payment gateway

    Possible cause:

    Error in any of the values entered when setting up the module, such as “Product ID” or “API key”.

    Solution:

    • Make sure you have correctly entered the “Product ID” provided by Support.
    • Make sure you have correctly entered the corresponding “API key” for the environment the module is in (staging/production).
    • Make sure the module is set up to operate in the correct environment (staging/production).

    Possible cause:

    Use of modules hasn’t been activated in the corresponding environment (staging/production) of Addon Payments.

    Solution:

    Go into the Addon Payments BackOffice Portal and tick the box “I’m going to use ecommerce platforms with plugins”. See the section of this guide called Add secure domain and activate compatibility with modules.

    Possible cause:

    The payment gateway hasn’t been activated as a secure domain in the corresponding environment (staging/production) of Addon Payments it is launched from.

    Solution:

    Go into the Addon Payments BackOffice Portal and add the domain with the module as a secure domain. For more information, see the section of this guide called Add secure domain and activate compatibility with modules.

    Comparte este documento
    Tabla de Contenidos

    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

    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

    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