API – Developers Docs API – Developers Docs
  • Addon Payments
  • POS integrated Payments
  • SpanishSwitch to Spanish
API – Developers Docs API – Developers Docs
API – Developers Docs
  • Addon Payments
  • POS integrated Payments
  • SpanishSwitch to Spanish
Addon Payments
  • Folder icon closed Folder open iconIntegrations
    • Start integrating
      • Welcome for CMS integrations
      • Introduction to integrations: Hosted, Host2Host and JavaScript
    • CMS Plugins
      • Prestashop
        • PrestaShop installation and set-up
        • Common mistakes with PrestaShop installation and set-up
        • Managing transactions with PrestaShop
      • WooCommerce
        • WooCommerce installation and set-up
        • Common mistakes with WooCommerce installation and set-up
        • Managing transactions with WooCommerce
      • Magento
        • Magento installation and set-up
        • Common mistakes with Magento installation and set-up
        • Managing transactions with Magento
      • Salesforce
        • Salesforce Commerce Cloud
    • Cards
      • Hosted Integration
      • Host2Host Integration
      • JavaScript Integration
      • PSD2 and 3DSv2
      • PCI DSS Certification
    • Complement your integration
      • Additional features
      • Managing notifications
      • Complement your JavaScript integration
      • Customizing the payment experience
      • Going Live (Switching to Production)
      • Encryption, signature and sending the request
      • Redirecting customer
    • Payment methods
      • Apple Pay
      • PayByBank
      • Bizum
      • PeX
      • Quix
    • Resources
      • Glossary
      • Payment solutions
      • Response codes
      • State and country codes
      • Currency codes
      • ID document type codes and validations
      • Test cards
    • Tools
      • Postman
      • SDKs
  • Folder icon closed Folder open iconBackOffice Portal
    • Pay by link guide
    • Search operations
    • Creating users
  • Folder icon closed Folder open iconFrequently Asked Questions

Welcome for CMS integrations

Introduction

The following guide covers the first steps for integrating the payment gateway into your ecommerce platform. The steps to follow are:

  1. Integrate Addon Payments into your website.
  2. Set your gateway to the staging environment.
  3. Make sure it works properly in the staging environment.
  4. Ask to go live (switch to production).

During the integration phase, you can do all the testing you need with the gateway to make sure it works properly. To do so, see the following sections of this guide:

  • Look things up on the BackOffice Portal.
  • Orders not updated on my platform.

Integrate Addon Payments into your website

The first step is to properly install a compatible payment gateway and set it up with the information in the welcome email.

The merchant has to do the installation, or have it done by the service provider or integration company that is developing or integrating your online sales platform. Caixabank and Addon Payments are not responsible for this process.

For these platforms, you have a free module you can download from this page or the corresponding integration guides. These guides explain how to integrate, the most common mistakes with incidents and steps to follow, and how to manage transactions.

These are the platforms available. Click here for the installation guide:

  • PrestaShop
  • WooCommerce
  • Magento
  • Salesforce

To use modules, you have to authorize the domains you want to integrate the gateway into and activate compatibility with modules. To do so, follow the steps in Annex 1 of this guide – Add secure domain and activate compatibility with modules.

If your ecommerce platform isn’t on the list above (platform developed in house or customized or modular platform without Addon Payments compatible module), there are more details on integrations of this sort in this introductory guide.

Set up your gateway in staging environment

Once you’ve integrated Addon Payments into your ecommerce platform, you have to enter the configuration data for your merchant. The data you need to operate in the staging environment is:

  • Environment or URL:
    • PrestaShop and WooCommerce:  “Production mode”: “disabled” in module set-up.
    • Magento: “Sandbox” on “Yes” in module set-up.
    • Custom developments: URLs of staging environments in the integration guides for each type of integration.
    • Merchant ID: Provided in registration email.
    • Product ID: Provided in registration email.
    • Merchant password (encrypted): Provided in registration email.
    • API key (modules and JS integration): Provided in registration email.

    For modular platforms (PrestaShop, WooCommerce and Magento), you can set up the gateway following the specific integration guide for your platform:

    • PrestaShop
    • WooCommerce
    • Magento

    Make sure it works properly in the staging environment

    With the payment gateway set up for the staging environment, it’s time for some test operations to make sure it works properly and your merchant data is set up correctly.

    We recommend placing several orders through your ecommerce platform, choosing credit card as the payment method and continuing to the payment gateway, where you will be asked for the card number.

    The following link has a list of cards that can be used to test various operations.

    Once you have completed the operations correctly, check that they are all on the operations list on the Addon Payments BackOffice Portal. See the section on Searching BackOffice Portal of this guide.

    Finally, check that the operations have updated the status of the orders on your ecommerce platform, marking them as authorized or declined, as applies. If this didn’t happen, see the section of this guide called Orders not updated on my platform.

    Ask to Go Live (switch to production)

    After testing and checking the payment gateway works correctly, you can request to switch to the production environment or go live.

    To do so, send an email to support@addonpayments.com with the merchant ID you want to take live.

    Once we’ve received your request, our team will make sure the payment gateway works properly on your ecommerce platform in the staging environment. To speed up the go live process, we recommend you verify these points before submitting your request:

    1. Go to the URL provided for the virtual POS installed. If the URL isn’t accessible, or the virtual POS is temporarily installed on another URL for development or testing, you can give us the URL to visit for validation purposes in the email you send requesting the switch.
    2. If a username and password or registered account are needed to complete the purchase process, please provide us with the necessary credentials. You can send them in the same email with your request to switch.
    3. We will check that the products or services on offer comply with current legislation and are allowed by Caixabank for remote sales. See Annex 2 – Products or services not allowed for remote sales. So, most of the products or services must be loaded on your online shop, with a picture. If you offer unauthorized products or services, they will have to be removed before you can be validated.
    4. We will choose a couple of items or make a booking, for rentals or hotels. The cart, booking engine or equivalent must be operational and allow us to complete the process. If specific steps are required to complete the order process, please include them in the same email with your request to switch.
    5. We will choose credit card as the payment method. The online shop must generate and send the operation to the payment gateway in the staging environment, where we will check that all the merchant data is set up correctly. Note: The merchant platform is not allowed to capture, process or send customer card details if you don’t have PCI DSS certification.
    6. If your ecommerce is a chemist that sells over-the-counter medicines, in addition to the requirements above, you must also meet those on the list of specific requirements for chemists selling medications.
    7. Once your website has been validated successfully, you will receive an email to the authorized account with the steps for taking your virtual POS live.
    8. If your shop isn’t successfully validated, you will receive a response to your request explaining why. You can ask to go live again when you’ve resolved the issue.

    Below is a summary of the list of requirements for going live:

    • Accessible URL, or provide an alternative URL.
    • Credentials, if necessary to complete payment.
    • Products or services loaded with pictures or photos.
    • Working cart, booking engine or equivalent.
    • No redirect to another page after choosing items.
    • Active gateway for card payments that is correctly set up in the staging environment.
    • Products or activities allowed for remote sales. See Annex 2 of this guide.
    • Chemists that sell medications. Must comply with the instructions in Annex 3 of this guide.

    Searching the BackOffice Portal

    There is a BackOffice Portal where you can search for, capture and void operations that are pending and issue refunds of previous operations.

    There is a guide to searching for operations on the Addon Payments BackOffice Portal with all the information you need.

    Orders not updated on my platform

    The most common issues that stop order statuses from being updated correctly are URL errors and errors involving server permissions.

    On the BackOffice Portal, you can check that notifications from Addon Payments are reaching your ecommerce platform correctly with the order statuses.

    To do so, find the “Transaction notifications” section at the bottom of the details for the transaction you want to check:

    • The information is broken down in the following columns:
      • Date created: Date the notification was sent.
      • Notification URL: URL the notification was sent to.
      • Received: Boolean that shows your ecommerce platform received the notification.
        • true: The notification was received properly by your web server. A confirmation code (HTTP 200) was received.
        • false: The notification was not received properly by your ecommerce platform’s web server. May be due to non-existent URL, restricted-access URL (HTTP 403), URL not found (HTTP 404) or internal server error (HTTP 500) on your platform.
          • Message: Content of notification generated.

        Note: If the notification can’t be delivered to the business site provided, AP will try again four (4) more times five (5) seconds apart.

        If notification delivery fails, we recommend you follow the steps below to locate and correct the cause of the incident:

        1. Go to the list of notifications for the transaction. Save the URL and content of the failed notifications.
        2. Use a search engine to find a web tool that allows you to send HTTP POST requests.
        3. Using the web tool of your choice, enter the notification URL on your platform in the outgoing URL. Use XLS format or type of content and notification message as the content.
        4. Click “Send” in the web tool and review the response code you get back.
        5. Check the code received and any solutions on the list of the most common HTTP response codes and rejections in this guide.

        List of the most common HTTP response codes and rejections

          HTTP 403

          Meaning: URL access prohibited.

          Cause: The URL we tried to send the notification to is restricted by host server permissions.

          Possible solutions:

          • Modular platforms (PrestaShop, WooCommerce, Magento):
            • Modular platforms can deny access to the notification delivery URL if they are in “maintenance” or “closed” modes.
            • Solution: Deactivate “maintenance” mode or open the website so the notification delivery URL is accessible.
            • All platforms:
              • Solution: Check hosting permissions so the notifications URL sent in the parameter “statusURL” or set up in the merchant is accessible from the Internet.
              • Solution: If you have a “Cloudfare” firewall, enable connections with HTTP/HTTPS protocol for the following IPs:
                • 35.189.207.233
                • 35.246.248.42
                • 35.195.204.5
                • 35.234.68.27
            HTTP 404

            Meaning: URL not found.

            Cause: URL the notification was sent to does not exist.

            Solution: Check that the URL sent in the parameter “statusURL” or set up in the merchant is correct.

            HTTP 500

            Meaning: Internal server error.

            Cause: The URL we tried to send the notification to returns an internal server error from the host server. This can happen with errors in ASP, .NET or Java implementation.

            Annex 1 – 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 register on the Addon Payments BackOffice Portal in the corresponding environment (staging/production). Follow these steps:

            1. Go into the Addon Payments BackOffice Portal in the corresponding environment (staging/production).
            2. If the settings are for a sub-merchant, go into it by clicking “Merchant settings” > “Merchant Management” on the bottom of the left menu.
            3. Click “Merchant settings” > “Domain settings”, on the bottom of the left menu.
            4. Check that the domain the payment gateway is launched from is on the “List of secure domains” you see there.
            5. If you need to add more than one secure domain, click “Add domain” and enter the URL.
              • The URLs entered require only the protocol (https://), subdomain and domain. Routes, parameters and tags are not necessary. For example: “https://www.mydomain.com/es/shop” is just “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, in the lower right corner.
            8. Reload the Addon Payments BackOffice Portal and make sure the changes have been saved.

                Comparte este documento

                Welcome for CMS integrations

                Copiar el enlace

                Clipboard Icon
                Tabla de Contenidos

                Products

                • Addon Payments
                • POS integrated Payments
                • Universal Pay

                Sales

                Tell us about your business so we can offer you the best solution.

                Contact an expert
                Contact an expert
                Contact an expert
                Contact an expert
                Contact an expert

                Technical Support

                Already a client and need help? Contact us, we’re here for you.

                Help

                Partners

                We work with the best partners for in-store and ecommerce solutions. Want to join us?

                Join us

                © Comercia Global Payments

                Privacy policy
                Exercising rights
                Client information
                Whistleblowing channel
                Legal disclaimer
                Cookies policy
                Ask AI
                Write your question. For example: How do I create a payment link?
                SmartWiki may skip data. Verify the information or contact support.

                SmartWiki, Powered by AI

                API - Developers Docs
                Manage cookie consent

                To offer the best experiences, we use technologies such as cookies to store and/or access device information. Consent to these technologies will allow us to process data such as browsing behavior or unique IDs on this site. Failure to consent, or withdrawal of consent, may adversely affect certain features and functions.

                Functional Always active
                Storage or technical access is strictly necessary for the legitimate purpose of allowing the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network.
                Preferences
                Technical storage or access is necessary for the legitimate purpose of storing preferences not requested by the subscriber or user.
                Statistics
                El almacenamiento o acceso técnico que es utilizado exclusivamente con fines estadísticos. Storage or technical access that is used exclusively for anonymous statistical purposes. Without a requirement, voluntary compliance by your Internet service provider, or additional records from a third party, information stored or retrieved solely for this purpose cannot be used to identify you.
                Marketing
                Storage or technical access is necessary to create user profiles to send advertising, or to track the user on a website or several websites for similar marketing purposes.
                Manage options Manage services Manage {vendor_count} vendors Read more about these purposes
                See preferences
                {title} {title} {title}

                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