Ingenico Direct Support Site

Results for

icon-search-large No search results yet
Enter your search query above

1. Introduction

Our SAP Commerce Cloud plug-in comes with regular updates and full integration support, guaranteeing a versatile out-of-the-box solution to accept online payments easily:

Check out our documentation to learn how to link your store with our platform to profit from all these features!

  • Entrust a system administrator with the installation and the configuration of the plugin
  • Accordingly, the target audience of this documentation are system administrators with a profound knowledge of SAP Commerce Cloud / Hybris

2. Create account

To process transactions with this plugin, you need an account on our platform.

This plugin works with both our test and live environment. A test account is a great way to get familiar with both the plugin and our platform. Once you want to go live, create a production account or contact us!

3. Install plugin

The first step to use the plugin is the installation process. Before you proceed, make sure your infrastructure meets these system requirements:

Item Description
Plugin package 

Download the plugin

Ingenico Direct credentials

Active test/live account on our platform


At least version 11, OpenJDK 11 is recommended

JAVA_HOME property will need to be set to the correct location for the installer to work correctly

SAP Commerce

Officially supported versions of SAP Commerce cloud are:

  • 2011.3
  • 2005.8

All other patch releases of 2011 and 2005 will be compatible with this plugin. However, the plugin is untested for other versions .
You will need to source a copy of SAP Commerce, as it is not included with the plugin

SAP Commerce components

The reference storefront implementation is designed to work with the Apparel Accelerator.

Use with the B2B Accelerator, Electronics Accelerator or others is not officially supported. However, the backend services are in place to facilitate this.

If you have already customized your system heavily, some additional integration may be required, as this plugin is designed to work with the standard Accelerator UI

Development environment

The examples in this document work with a UNIX-based development environment (e.g. Mac OS X or Linux).

For Windows installations, use the appropriate Windows commands (e.g. setantenv.bat, hybrisserver.bat)

PCI compliancy

SAQ A (14) 

The plugin’s in-built features ensure this security level, but you still need to get the certificate from your acquirer

On top of these prerequisites, make sure to respect the extension structure:

Property Description
ingenicoogonedirectb2ccheckoutaddon Contains the storefront modifications required to facilitate the injection of the Ogone Direct payment journeys into the B2C Apparel Storefront Checkout Journey
ingenicoogonedirectbackoffice Contains Backoffice modifications to facilitate configuration of the plugin
ingenicoogonedirectcore Contains any data model additions and functional services which use our REST API. Also includes the Java SDK
ingenicoogonedirectcustomersupportbackoffice Contains modifications to the Customer Support Backoffice perspective which allow a Customer Support agent to manually capture or refund a transaction.
ingenicoogonedirectfulfillmentprocess Contains modifications to the Out of the Box SAP Commerce order fulfillment Business Process. It allows you to control whether the system waits for a transaction to be auhorised/captured before delivering the goods/services to your customers
ingenicoogonedirectocc Contains enhancements to the Omni Commerce Connect REST APIs included with SAP Commerce: You can process payments from a headless storefront or mobile app
ingenicoogonedirectwebhook Contains an endpoint for transaction status updates from our platform via webhooks

This installation process applies to either

  • a brand-new project with a standard
  • out of the box accelerator storefront
  • an existing project with its own storefront extension based on yacceleratorstorefront

Once done, follow these steps:

    1. Install SAP Commerce using ‘cx’ Recipe
      SAP provides instructions for using the installation recipes in the SAP Help Portal. If you are unfamiliar with the general installation process, make sure to read through this before the installation.

      You will require an existing installation of SAP Commerce to use the plugin. If you already have an installation of SAP Commerce with the B2C Accelerator and its corresponding extensions included, skip this step
      • Download SAP Commerce in .Zip format. Unzip the platform and navigate to the ‘installer’ directory
      • Run the following command:

        ./ -r cx -A local_property:initialpassword.admin=your_password

        Replace ‘your_password’ with your desired administrator password for the system

      • Run the following to build and initialise the system:

        ./ -r cx initialize -A local_property:initialpassword.admin=your_password

    2. Add Extensions to Codebase
      • Download and unzip the file
      • Confirm you have received the following directory structure

      • The config directory contains a sample set of configurations in the file. Copy these configurations into the file generated after the SAP Commerce installation
      • The config directory also contains a localextensions.xml file. Add the following from this file to your own localextensions.xml file that was generated after the SAP Commerce installation:
        <!-- INGENICO -->
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectcore"/>
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectb2ccheckoutaddon"/>
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectbackoffice"/>
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectocc"/>
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectwebhook"/>
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectcustomersupportbackoffice"/>
        <extension dir="${HYBRIS_BIN_DIR}/custom/ingenico/ingenicoogonedirectfulfilmentprocess"/>

        You should examine each extension’s extensioninfo.xml file (contained within the root of each extension’s directory) to ensure the extensions mentioned within each <requires-extension> tag are included in your localextensions.xml.
      • The bin/custom/ingenico directory contains all required extensions. Copy them into your own hybris/bin/custom/ingenico directory. If you wish to put these extensions in a different directory, update your localextensions.xml accordingly

    3. Install Extension to Storefront
      • You may need to run the following command to ensure the correct addons are available in your storefront:
        1ant addoninstall -Daddonnames="adaptivesearchsamplesaddon,assistedservicecustomerinterestsaddon,
        ysapproductconfigaddon" -DaddonStorefront.yacceleratorstorefront="<YOUR-STOREFRONT>"

        Replace <YOUR-STOREFRONT> with your storefront extension’s name, e.g. yacceleratorstorefront or <project>storefront

        To run the ant commands below, you will need to run . ./ or its Windows equivalent within the hybris/bin/platform directory.
      • Install the Addon to your Storefront, use the following command:
        1addoninstall -Daddonnames="ingenicoogonedirectb2ccheckoutaddon" -DaddonStorefront.yacceleratorstorefront="<YOUR-STOREFRONT>"
      • Now rebuild your system:
        ant clean all

      • Perform either an initialisation or system update. You can do both via the Hybris Administration Console (HAC) at https://<your-server>:9002/hac or you can initialize this via the ant target:
        ant initialize

4. Configure plugin

After the installation, you need to configure the plugin to link your store to our platform.

This section of the documentation will cover technical configuration elements only. For business configuration within the SAP Backoffice, check this section.

    1. Configure properties
      • From ingenicoogonedirectcore/

        The Java SDK passes these configurations and controls the connectivity. Have a look at our dedicated Java SDK documentation for more information

      • From ingenicoogonedirectbackoffice/ subject

        These configurations control the button within the Back Office which is used to contact us for support via email

      • From ingenicoogonedirectocc/


        These configurations set the value for the Server API’s property HostedCheckoutSpecificInput.ReturnUrl to ensure your customers correct redirection to your webshop environment. It is important to update these values to reflect your system’s URL

    2. Configure Webhooks
      The plugin uses webhooks to get the current status of your transactions from our platform. SAP Commerce uses the endpoint /ingenico/webhook to receive these status updates.

      Configure a WebhooksKey, WebhooksKeySecret and Endpoint URLs in your PSPID as described in our dedicated guide. Make sure the URL
      • Contains your site’s hostname '(i.e. https://<your-domain>:9002/ingenico/webhook)'
      • Has a valid SSL certificate

    3. Configure SAP
      The following steps cover the configuration process of the SAP Commerce Backoffice tool. For general information about the SAP Commerce Backoffice, refer to the Business User guides in the SAP Help Portal.

      After the successful installation, the SAP Backoffice contains a new item type “Ingenico Configuration”. Follow these steps to link your Base Store in SAP Commerce to our platform:

      • Login to the SAP Commerce Backoffice via the default URL https://<hostname>:9002/backoffice. Default administrator credentials will have been defined during installation or provided to you separately
      • Go to Ingenico > Ingenico Configuration. Click on the “+” – symbol in the taskbar

        The image above shows where to find the Ingenico Configuration item and the “+” symbol in the taskbar

      • Enter the following from the table in the appearing pop-window: 
        Property Description/Actions
        API Key Enter the API key of your test or live PSPID. Read our dedicated guide to learn how to generate one
        API Secret Enter the API secret of your test or live PSPID. Read our dedicated guide to learn how to generate one
        Ask Consumer Consent Configure this in the following step
        Endpoint URL

        The test or live endpoint on our platform. Copy them from our dedicated guide.

        • Read our dedicated guides about API endpoints and authentication to get a thorough understanding about the test/live environment and API key/API secret
        • Make sure not to mix up credential from test with live and vice versa
        • Make sure to switch to the LIVE-URL as soon as you have finalised your tests
        Merchant ID Enter the PSPID on our platform you want to use for transaction processing
        webhookKeyId Enter the webhooks Key ID of your test or live PSPID from the previous step
        webhookSecret Enter the Webhooks Key Secret of your test or live PSPID from the previous step
        Click on "DONE" to confirm your configuration

      • Click on the configuration profile in the table you have just confirmed. Enter the following from the table overview:
        Property Description/Actions
        • Operation Code: Define whether to process the transactions as authorisation mode or as direct sale. Select one of the following options:
          • Authorization: the amount is only blocked on your customer's card. Successful transactions will have StatusCode=5 (this is used when you wish to capture a transaction only after shipping the article)
          • Sale: the amount has been ordered to be paid out in one go. Successful transactions will have StatusCode=9

        • Capture Time Frame: Set a capture delay for authorised transactionof X days. At the end of this duration, a cron job will capture the transaction automatically. If the transaction is partially captured already in the meantime, any available funds that remain will be captured

        If "Operation Code" is set to "Authorization", beware of the following:
        • Make sure that you capture authorised transaction later. Only then the transaction will reach StatusCode=9, for which you receive the actual payment for the transaction
        • Even if the "Capture Delay" is set to X days, you can also manually capture funds fully/partially by opening an individual order once you have delivered the goods/services

        Click on “SAVE” to confirm your configuration

    4. Configure Base store
      Before you start processing (test) transactions, you need to

      • Link your Base stores with the plugin configuration
      • Select an integration mode

      To do so, follow these steps and confirm by clicking "SAVE" in each tab:

      • Go to Base Commerce > Base Store. Select the store from the table with headers "ID" / "Name"
      • Select "Ingenico" from the available tabs and scroll down to "INGENICO CONFIGURATION"

        The image above shows where to find the "INGENICO" tab.

      • Enter the following from the table overview: 
        Property Description/Actions
        Payment Provider Configuration

        Associates your base store with a configuration profile

        Click on the field to select the configuration profile you set up in the previous steps

        Checkout type Select an integration mode for transaction processing

        If you choose "Hosted Tokenization", make sure to configure a template via Ingenico > Ingenico Configuration

        Do not switch between checkout modes whilst the site is live, as this might lead to undesirable effects on your customers' payment journey.

        Checkout type Description/Actions
        Hosted Tokenization

        All card brands bundled together in a single iFrame on your checkout page itself via our Hosted Tokenization Page
        Your customers stay on your checkout page while entering their card details in an iframe hosted on our server. The iframe presents a single payment method "Credit card" which autodetects the card brand based on card number input

        Read our dedicated guide about Hosted Tokenization Page to leanr more about this integration mode

        Bancontact is available only on Hosted Checkout Page in QR code mode
        Hosted Checkout

        Each card brand listed individually for redirect upon selection to our Hosted Checkout Page

        All card brands are listed individually on your checkout page. Upon selection of the brand, the plugin redirect your customers to our Hosted Checkout Page to enter their card credentials for the selected brand

        Read our dedicated guide about Hosted Checkout Page to leanr more about this integration mode

      • Select "ADMINISTRATION" from the available tabs and scroll down to "UNBOUND". Enter "ingenicoB2CResponsiveCheckoutGroup" in field "Checkout Flow Group"

        The image above shows where to find the "ADMINISTRATION" tab.
      • Select "PROPERTIES" from the available tabs and scroll down to "PAYMENT PROVIDER". Enter "Ingenico" in field "Payment Provider"

        The image above shows where to find the “PROPERTIES” tab.

    5. Test connection
      Once you have completed all the steps, verify the configuration by establishing a test connection between the plugin and our platform:

      • Go to Ingenico > Ingenico Configuration. Select the configuration profile from the table with headers "Merchant ID" / "API Key"
      • Click on "Test connection" in the configuration profile overview. Check that the appearing pop-up window states "OK (success)". If the pop-up window indicates a failed test, contact your system administrator for troubleshooting

        The image above shows where to find the “Test connection” button in the configuration profile overview and a success message.

5. Manage payments

We have designed the plugin to follow-up on your orders automatically and autonomously, freeing you from the administration involved. Learn here how to use our plugin effectively to make your business thrive!

Perform maintenance operations

Captures, refunds and cancellations of authorisations are standard processes (also known as maintenance operations) in your everyday business logic. Learn here how to perform these operations in the SAP Backoffice

Perform test transactions

Use our platform’s test environment to make sure your plugin works as intended. We offer test data sets on both our dedicated test cases page and in the “Testing” tab for individual payment methods.

The image above shows where to find the “Testing” tab

Make sure to switch to the LIVE-URL as soon as you have finalised your tests