Search docs

Are you looking for test card numbers?

Would you like to contact support?

Start searching Adyen's documentation...

  Documentation

Set up the add-on

Install the Adyen payments add-on for SAP Commerce (formerly Hybris), and configure it in your SAP back office and in the Adyen Customer Area.

Before you begin

Make sure that you have created a test account with Adyen. With this, you'll be able to access the test Customer Area, and apply for a live account. While you wait for your live account credentials, you can start integrating by using your test account. 

Install the add-on

Adyen's payments add-on for SAP Commerce is open-source and available on GitHub. To install it:

  1. Download the latest version available on GitHub.
  2. Copy the files to: ${HYBRIS_BIN_DIR} > Custom > [YourHybrisInstallationFolder].
  3. Verify the folder and file permissions of the copied files.
  4. Add the Adyen extensions to the config/localextensions.xml file:

    <extension dir="${HYBRIS_BIN_DIR}/custom/adyenv6core"/>
    <extension dir="${HYBRIS_BIN_DIR}/custom/adyenv6b2ccheckoutaddon"/>
    <extension dir="${HYBRIS_BIN_DIR}/custom/adyenv6backoffice"/>

    If you are using yacceleratorordermanagement (b2c_acc_oms recipe), also add:

    <extension dir="${HYBRIS_BIN_DIR}/custom/adyenv6ordermanagement"/>

    If you are using yacceleratorfulfilment (b2c_acc recipe), also add:

    <extension dir="${HYBRIS_BIN_DIR}/custom/adyen-hybris/adyenv6fulfilmentprocess"/>
  5. Modify the config/local.properties file by appending to the value of csrf.allowed.url.patterns the following: 

    ,/[^/]+(/[^?]*)+(adyen-response)$,/adyen(/[^?]*)+$

  6. Install the Adyen add-on into your existing storefront template:

    cd bin/platform
    . ./setantenv.sh
    ant addoninstall -Daddonnames="adyenv6b2ccheckoutaddon" -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
    ant clean all

Configure the add-on

  1. Log in to your SAP back office
  2.  Go to BaseStore > Adyen
    This opens a page with settings for the Adyen add-on. 
  3. Configure the settings by following the instructions below.

Account settings

Field name  Instruction
Merchant account name

The name of your Adyen merchant account for which the payments will be processed. You can find this in the upper-right corner of your Customer Area.

Immediate capture flow

This has to match the capture delay that you set in the Adyen Customer Area.

If you set Capture Delay to manual, set Immediate capture flow to False. Otherwise, set Immediate capture flow to True.

To set the capture delay in the Adyen Customer Area:

  1. Log in to your Adyen Customer Area.
  2. Go to Account > Settings.
  3. In the Capture Delay drop-down menu, select one of the following: 
    • immediate if you want payments to be captured immediately after authorisation (this is the default setting).
    • the number of days between authorisation and automatic capture.
    • manual if you want to capture all payments manually from the SAP back office.
  4. Click Submit.

Allowed Credit Card Types

Select which credit card types you want to allow in the checkout form. You also need to enable these credit card types in the Adyen Customer Area.

Recurring contract type

Select the type of recurring transactions that you want to enable. Possible values:

  • RECURRING  – Enable stored payment methods for shopper-not-present transactions.
  • ONECLICK – Enable stored payment methods for shopper-present transactions. For credit cards, the shopper needs to enter their CVC/CVV to complete the payment.
  • RECURRING,ONECLICK – Enable stored payment methods for both shopper-present and shopper-not-present transactions.
 Adyen Test mode Select True if you are using the Adyen test environment, and False if you are using the Adyen live environment.

API settings

For authenticating API requests from your SAP back office, you need to set up an API key.  To securely collect card details, you also need to create an origin key for using our Secured Fields Javascript library

First, set up these keys in your Adyen Customer Area:

  1. Log in to your Adyen Customer Area.
  2. Go to Account > Users, and find the user ws@Company.[YourCompanyAccount].
  3. In the Authentication pane, click Generate New API Key.

  4. Copy the API key, and store it securely in your system.
  5. In the Origin key pane, enter your URL, and then click Generate Origin Key.

  6. Copy the origin key, and and store it securely in your system.

  7. Click Save at the bottom of the page.
Field Instruction

API Endpoint URL Prefix

Enter the URL prefix [random]-[company name] from your Adyen live Customer Area > Account > API URLs. For more information, refer to Checkout endpoints.

Web Service User API Key

The API key from your Adyen Customer Area.

WS User Origin Key

The origin key from your Adyen Customer Area.

Server notification settings

To inform your SAP back office of payment status changes, Adyen uses notifications, sent as HTTP callbacks (webhooks) to endpoints on your server.

You first need to set up notifications in your Adyen Customer Area:  

  1. Log in to your Adyen Customer Area.
  2. Go to Account > Server Communications.
  3. Next to Standard Notification, click Add
  4. In the URL box, enter your website URL followed by /adyen/v6/notification/json.
  5. Select the Active checkbox.
  6. From the Method dropdown, select JSON.
  7. In the Authentication pane, enter a User Name and Password for notifications.
  8. Store these credentials securely in your system.
  9. Click Save Configuration.
Field Instruction
Server Communication HTTP Basic username The username for notifications from your Adyen Customer Area.
Server Communication HTTP Basic password The password for notifications from your Adyen Customer Area.

Test notifications

To test whether notifications have been configured correctly: 

  1. Log in to your Adyen Customer Area.

  2. Go to Account > Server Communications.

  3. Next to Standard Notification, click Edit & Test
  4. In the Test Notifications pane, click Test Configuration
  5. If the result is [Accepted], your notifications are working correctly.

Hosted payment pages settings

skin is an interface overlay that is applied to the Adyen Hosted Payment Page (HPP) to create a seamless checkout experience for your shoppers.

You first need to create a skin in the Adyen Customer Area

  1. In the Adyen Customer Area  go to  Account > Skins.
  2. Click the  New tab. 
    This opens a page with settings for the new skin. 
  3. In the Description box, enter a description for your skin.
  4. Click Generate new HMAC key for the Test platform.
  5. Copy this key and store it securely in your system.
  6. Leave the Result URLs and Continue-to URLs empty.
  7. Click Create New Skin on Test.
Field Instruction
HPP skin code

The code of the skin that you want to use. You can find this in your Customer Area, under Account > Skins.

HPP skin HMAC key

The HMAC key for the skin that you want to use.

Boleto

To accept Boleto payments:

  1. In your SAP back office, go to the Advanced Settings section.
  2. Set Enable Boleto to True.

Next steps