Ingenico Direct Support Site

Results for

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

1. Introduction

Our Salesforce 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 Salesforce Commerce Cloud / Demandware

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

Salesforce Commerce Cloud

Compatibility with Salesforce Commerce Cloud version Storefront Reference Architecture (SFRA)

  • 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

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

Once done, follow these steps:

    1. Install cartridge
      You can use the cartridge with Storefront Reference Architecture (SFRA). Install the cartridge to your project root directory at the same level as storefront-reference-architecture. Have a look at this folder structure example:
      
      my-project/
      |-- link_ingenico_ogone/
      |  |-- cartridges/
      |  |  |-- bm_ingenico_ogone/
      |  |  |-- int_ingenico_ogone/
      |  |-- documentation/
      |  |-- metadata/
      |-- storefront-reference-architecture
      |  |-- cartridges/
      |  |  |-- app_storefront_base/
      |  |  |-- modules/
      

      If you have renamed the storefront-reference-architecture folder, make sure to update the base path in package.json
    2. Install Node modules
      From the cartridge’s root directory, install Node modules using your command line:
      
      npm install

    3. Build code
      From the cartridge’s root directory, compile the client-side assets using your command line:
      
      npm run build
    4. Upload code
      Upload int_ingenico_ogone and bm_ingenico_ogone using Commerce Cloud UX Studio or
      sgmf-scripts command line utils.

    5. Import metadata
      To add new configuration items, import the predefined metadata by following these steps:
      • Open the /metadata/site_import/sites/ folder
      • Rename the yourSiteId folder to the ID of your site in the Business Manager
      • Zip the site_import folder
      • In the Business Manager, go to Administration > Site Development > Site Import & Export and import the zipped file


      After the import, attributes named ingenicoOgone[attributeName] are added to Administration > Site Development >:

      System Object Types > Site Preferences > Attribute Definitions
      System Object Types > Order > Attribute Definitions
      System Object Types > OrderPaymentInstrument > Attribute Definitions
      System Object Types > CustomerPaymentInstrument > Attribute Definitions
      Custom Object Types

      The service ingenico.https.direct.yourSiteId is added to Administration > Operations > Services

4. Configure plugin

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

You need to enforce HTTPS in the Salesforce Commerce Cloud to be compatible with the Chrome v80 policy.

Login to the Business Manager. Set the following values in the menus and confirm by clicking "Apply" or "Save":

    1. Set Cartridge paths
      To embed an external module and link it with the Business manager, follow these steps:
      • Go to Administration > Sites > Manage Sites > [yourSite] > Settings. Enter the following in "Cartridges":

        int_ingenico_ogone:app_storefront_bass

        Scc-1.png
        The image above shows where to add the value in the Settings menu

      • Go to Administration > Sites > Manage Sites > Manage the Business Manager site > Settings. Enter the following in front of any other existing cartridges:

        bm_ingenico_ogone:int_ingenico_ogone:bm_app_storefront_base:bm_custom_plugin


        Scc-2.png
        The image above shows where to add the value in the Settings menu

    2. Define Business Manager permissions
      Manage the access rights of the module to ensure correct interaction with your Business manager and storefronts:
      • Go to Administration > Organization > Roles & Permissions. Click on the role you want to update in the table. Go to Business Manager Modules
      • In the "Select context" pop-up, select all storefront sites that will use Ingenico-Ogone Payments Cartridge

        Scc-3.png
        The image above shows where to flag the storefront sites in the Business Manager Modules
    3. Configure credentials for Test/Live environment
      To target our test/live environment and make sure that your requests are legitimate, you need to configure URL endpoints and an API key/secret pair linked to a specific PSPID.

      • Go to Administration > Operations > Services. Open the “Credentials” tab
      • Click on the ingenico.https.direct.yourSiteId.TEST in column “Name” in the table to configure either test/live. Perform the action for both environments

        Scc-4.png
        The image above shows where to select the name representing the test/live environment

        Enter the following in the table: 
        Property Description/Actions
        Name Replace yourSiteId with the actual ID for your site
        URL The test or live endpoint on our platform. Copy them from our dedicated guide.
        User Enter the API key of your test or live PSPID. Read our dedicated guide to learn how to generate one
        Password Enter the API secret of your test or live PSPID. Read our dedicated guide to learn how to generate one
      • Open the Services Tab. Click on ingenico.https.direct.yourSiteId and enter the following in the table:
        Property Description/Actions
        Name Replace yourSiteId with the actual ID for your site
        Communication Log On test environments, the communication log could be enabled for debugging purposes
        Credentials Check the updated service credentials are selected.

        Perform the action for both environments.

        • Read our dedicated guides about API endpoints and authentication to get a thorough understanding about the test/live environment and API key/API secret
        • We strongly recommend configuring a separate name for both our test and live environment. This will allow you to manually switch from one environment to the other easily
        • Make sure not to mix up credential from test with live and vice versa
    4. Set up Merchant ID, Data Locale and Operation code
      Every transaction is channelled via a test/live PSPID on our platform. You also need to define whether our platform processes transactions in authorisation or direct sale mode. If your customers’ native language is different than English, you also need to define the language of the payment pages via the locale.

      • Go to Merchant tools > Site Preferences > Custom Preferences. Click on “INGENICO_OGONE” in column “ID” for setting up your general configuration to connect your store to our platform. Perform the actions as stated in the table:

        Scc-5.png
        The image above shows where to select the ID to be configured

      • Enter the following data on the site:
        Property Description/Actions
        Merchant ID Enter the PSPID on our platform you want to use for transaction processing
        Date Locale Optional – only relevant if your storefront site uses a different locale than English
        You must set the Date pattern in an unused English locale. ie.: en_EN , en_CA

        Used to generate a signature to authenticate requests sent to our platform. One of the headers used to generate this signature is the date, which needs to be in a specific format

        The locale also defines the language of the payment pages

        To set up the locale, follow these steps:

        • Go to Administration > Global Preferences > Locales. Click on a locale from the list (column “Locale ID”)
        • Go to tab Regional settings. Enter “EEE, dd MMM yyyy HH:mm:ss z” in Date Settings > Long Date Pattern
        • Go back to Merchant tools > Site Preferences > Custom Preferences > INGENICO_OGONE. Enter the locale from the list (column “Locale ID”) you have just configured

        Make sure to use only locales that are available on our platform. Find a full overview for both Hosted Checkout Page and Hosted Tokenization Page here
        Operation code

        Define whether to process the transactions as authorisation mode or as direct sale. Select one of the following options:

        • Authorisation (FINAL_AUTHORISATION): 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 (SALE): the amount has been ordered to be paid out in one go. Successful transactions will have StatusCode=9

          If you authorise payments only, make sure that you capture them later. Only then will the transaction reach StatusCode=9, for which you receive funds

          Use either a
          • Automatic Capture Job: You can set the capture delay of X days in the given field. At the end of this duration, a cron job will capture the transaction automatically
          • Custom capture procedure: You can manually capture funds fully / partially by opening an individual order once you have delivered the goods/services
      • Configure payment methods and integration modes
        We categorise payment methods in two different clusters
        • Card payments
        • Alternative payment methods

          You can process card payments either via Hosted Tokenization Page or Hosted Checkout Page, whereas the alternative payment methods are available only via Hosted Checkout Page

          Follow these steps to make your choice:
          • Go to Merchant tools > Ordering > Payment methods. Click on either “INGENICO_OGONE_CARD”/”INGENICO_OGONE_REDIRECT” in column “ID”. Make sure to select YES for enabled. Perform the actions as stated in the table:
            ID value Description/Actions
            INGENICO_OGONE_CARD Covers all card-based payment methods

            You can offer these to your customers in two ways:
            • 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

              Select “(1) Hosted Tokenization Page” to use this option

            • 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

              Select ”(2) Hosted Checkout Page” to use this option

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

            INGENICO_OGONE_REDIRECT

            Covers all alternative payment methods (digital wallets, mobile payment methods, gift cards etc.)

            Upon selection of the brand, the plugin redirects your customers to our Hosted Checkout Page or to the third-party provider for entering the payment credentials

            Only option ”(2) Hosted Checkout Page” is available for these payment methods.

            • Have a look at all available payment methods our platform has to offer
            • The plugin uses a specific API call in real-time to ensure your customers can choose any active payment method in your PSPID (Login to our test/live Back Office to check via Configuration > Payment methods) in your store. If you want to add more payment methods to your account, contact us
          • Go to Merchant tools > Site Preferences > Custom preferences. Click on either of them in column “ID” to configure and customise them

            Scc-6.png
            The image above shows where to select the “INGENICO_OGONE_CREDIT”/ ”INGENICO_OGONE_REDIRECT” to be configured
            ID value Description/Actions
            INGENICO_OGONE_CARD

            Settings for the Hosted Tokenization Page

            • Checkout type: select either
              • Hosted Checkout Page (1): Instead of using Hosted Tokenization Page for card payments, all payment methods are offered via Hosted Checkout Page

              • Hosted Tokenization Page (2): All Hosted Tokenization Page payment methods available are offered via this integration

            • Hosted Tokenization JS: Enter the valid tokenisation URL as an iframe on your checkout page. Find it in our documentation

            • Hosted Tokenization Template: Enter the file name of your template to adapt the iframe to the look and feel of your shop. Learn how to create templates in our documentation

            If you select Hosted Checkout Page for integration mode, upload the payment page template in Ingenico_Ogone_Redirect
            INGENICO_OGONE_REDIRECT

            Settings for the Hosted Checkout Page 

            • Hosted Checkout Template: Enter the file name of your template to adapt our payment page to the look and feel of your shop. Learn here how to create templates

      • Configure webhooks
        The plugin uses webhooks to get the current status of your transactions from our platform. This way your store database is always up to date.

        • Configure a WebhooksKey, WebhooksKeySecret and Endpoint URLs in your PSPID as described in our dedicated guide. Make sure to use the following formula for your endpoint URLs:

          https://{domain}/on/demandware.store/Sites-{yourSiteId}-Site/{locale}/IngenicoOgone-Webhooks

        • Go to Merchant tools > Site Preferences > Custom preferences. Click on “INGENICO_OGONE_WEBHOOKS” in column “ID”. Perform the actions as stated in the table:

          Scc-7.png
          The image above shows where to select the “INGENICO_OGONE_WEBHOOKS” to be configured
          ID value Description/Actions
          Webhooks Key ID

          Enter the webhooks Key ID of your test or live PSPID from the previous step

          Webhooks Key Secret Enter the Webhooks Key Secret of your test or live PSPID from the previous step
        • Go to Administration > Operations > Jobs. Click on “IngenicoProcessWebhooks” in the list. Go to Job Step to set the scope to your site. Configure the schedule for the job based on your needs

          Depending on your business volume for near real-time transaction processing, we recommend setting the job schedule between 1 and 5 minutes. The default value for job schedules is 5 minutes

          Find a thorough overview on possible webhook events in our dedicated documentation

      • 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 Merchant Tools > Ordering > Ingenico-Ogone Transactions. Click on the “Test API connection” button. Check that the appearing dialogue box states “Connection to the Ingenico-Ogone API succeeded”

          Scc-8.png
          The image above shows where to find the “Test API connection” button in the Business Manager

          Scc-9.png
          The image above shows where to find the “Test API connection” button in the Business Manager



    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!

    Follow-up on orders Check payment status / Process unconfirmed orders

    To make sure

    • your platform registers successful payments (StatusCode=5 or 9 and Status=”PAYMENT_CREATED”) as such and not as unfinished (because of a failed redirection of your customers to the Salesforce Commerce Cloud website
    • authorised transactions are finalised by a capture (If you choose Operation Code: Authorisation during the initial order)

    the plugin implements the “Check payment status job”. Follow these steps to make them work:

    • Modify property cancelUnconfirmedOrderAfterHours to the desired amount of hours after which the plugin cancels an order in a pending status
    • Check out how to capture authorisations automatically or manually

    Capture authorisation automatically

    If you choose to authorise transactions only during the initial order, our plugin will capture them for you at a later point. You can define the intervals and the timing for the captures based on your business requirements.

    • Go to Administration > Jobs > IngenicoCaptureAuthorizedPayments > Schedule and History. Perform the actions as stated in the table for the respective capture mode:
      Capture mode Description/Actions
      Capture authorisations several times a day
        • Check the “Enable” checkbox
        • Set “Trigger” to “Recurring interval”
        • Set “Interval” to “Hours” and “Amount” to the desired time span (in hours) that should pass between the captures
        • Define the time of the initial capture in “From”. Counting from this time, captures are run every X hour you defined in “Amount”
        • Set “ingenicoOgoneCaptureProcedureDelay” to define which authorisations from X days ago should be captured

      Capture payments at the end of the day
        • Check the “Enable” checkbox
        • Set “Trigger” to “Recurring interval”
        • Set “Interval” to “Days” and “Amount” to “1”
        • Define the time of the capture in “From”
        • Set “ingenicoOgoneCaptureProcedureDelay” to “0” to ensure all pending authorisations are captured at the end of the same day without any delay
      The timing of the captures depends on the time zone you have configured in the Business Manager. Check this on the bottom of your browser

    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 Business manager:

    • Go to Merchant Tools > Ordering > Ingenico-Ogone Transactions. Look up the transaction in question and click on “Details” in column “Category”
    • The dialogue box shows the possible actions you can perform on a transaction. Perform the action as stated in the table to perform the respective maintenance operations

      Scc-10.png
      The image above shows how to reach the menu to perform maintenance operations

      Maintenance operations Description/Actions
      Capture

      Capture authorised transactions (StatusCode=5 / Status=PENDING_CAPTURE) to effectively receive the funds for the order

        • Click on the “Captures” tab. The table shows all captures so far
        • In “Add a new capture”, add the (partial or full) amount in “Amount” and click on the “Capture” button to confirm. If you have not captured the full amount yet, you can perform multiple follow-up captures until you have reached the full amount


      Scc-11.png
      The image above shows where to fill in the amount to capture and the “Capture” button

      If you want our plugin to capture transactions automatically, follow these instructions

      Refunds

      Reimburse your customers for captured transactions (StatusCode=9 / Status=COMPLETED)

        • Click on the “Refunds” tab. The table shows all refunds so far
        • In “Add a new refund”, add the (partial or full) amount in “Amount” and click on the “Refund” button to confirm. If you have not refunded the full amount yet, you can perform multiple follow-up refunds until you have reached the full amount


      Scc-12.png
      The image above shows where to fill in the amount to refund and the “Refund” button

      Cancellations

      Cancel authorised transactions (StatusCode=5 / Status=PENDING_CAPTURE)

        • Click on the “Refunds” tab. The table shows all refunds so far


      Scc-13.png
      The image above shows where to find the “Refund” button

    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.

    Scc-14.png
    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