Home

One integration gives you access to all features of the Adyen payments platform, including all global and preferred local payment methods, recurring payments, risk management, and conversion optimization. Integrate Adyen via SAP B2C Accelerator and take advantage of pre-built storefront components to get you up and running quickly.

SAP Commerce Cloud (Hybris) Adyen Plugin

Supported versions

If you want to offer PayPal as a payment method, you have to use plugin version 7.1.0 or later.

This documentation reflects the latest version of the plugin. You can find the latest version on GitHub. Our plugin supports the following:

SAP version 1905 or later. We cannot offer support if you are not using the default SAP checkout. We do not recommend customizing the plugin, because this could make it harder to upgrade and maintain your integration. If you decide to customize, we recommend that you:

Keep track of the custom code added to your integration. Create an issue on GitHub if you want to suggest a new feature for the plugin.

Features

• Credit cards: accept credit card payments on your website and mobile application, without redirecting to an external website. Sensitive cardholder data is collected securely using our Card Component, which reduces your PCI DSS-compliance requirements.
• Dynamic 3D Secure 2 authentication, including AVS checks.
• Local payment methods: accept local payment methods including iDEAL, Sofort, Klarna, Giropay, Google Pay, and many others.
• In-store payments: accept in-person payments from payment terminals.
• Backend orders: initiate backend orders (MOTO), with the option to use stored payment methods.
• Tokenization: offer returning shoppers a faster checkout experience by saving their card details, or implement subscription payments on POS.
• Revenue Protect: use our risk management systemto identify and block fraudsters, while reducing friction for legitimate shoppers. You can either fully automate the risk management process, or add manual review for certain payments.

Supported payment methods

Below is a list of payment methods supported in the latest version of the plugin. Our plugin currently does not support express payment methods, where the Pay button is on the product page. If you want a new payment method to be added to our plugin, open an issue on GitHub.

Add payment methods to your account

Before you can use new payment methods, you need to add them to your account:

1. Log in to your Adyen Customer Area.

• For a test integration, log in to your test Customer Area.
• For a live integration, log in to your live Customer Area.

2. Switch to your merchant account.
3. Go to Settings > Payment methods.
4. Select Request payment methods.
5. Start entering the name of the payment method, then select it from the drop-down list.
6. Select Submit.

Credit and debit cards

Payment method	Countries
American Express	International
Bancontact(via the card component)	BE
Cartes Bancaires	FR
China UnionPay	International
Diners	International
Discover	International
Elo	BR
Hipercard	BR
JCB	International
Maestro	International
Mastercard	International
Troy	TR
Visa	International
Dankort	DK
Hipercard	BR

Cash and ATM

Payment method	Countries
Boleto	BR
Multibanco	PT

Direct Debit

Payment method	Countries
SEPA Direct Debit	Eurozone

Online banking

Payment method	Countries
EPS	AT
giropay	DE
iDEAL	NL
Interac Online	CA
Online bankingIndia	IN
MB WAY	PT
Pix	BR
Polish online banking (Dotpay)	PL
Sofort	AT, BE, CH,DE, ES, GB,IT, NL, PL
Klarna -Pay now	AT, BE, CH,DE, ES, GB,IT, NL, PL, SE
Thai online banking	TH
Trustly	DK, FI, NO, SE, and more.

• Trustly is supported in more European countries. Contact Support Team for more information.

Buy Now Pay Later

Payment method	Countries
3x 4x Oney	FR, ES
Affirm	US
Afterpay	AU, CA, NZ, US
Clearpay	GB
Klarna - Pay later	AT, CH, DE, DK, FI, GB, NL, NO, SE, US
Klarna - Pay over time	AT, AU, CH, DE, DK, FI, GB, NO, SE, US
PayBright	CA
RatePay	AT, CH, DE, NL

Prepaid and gift cards

Payment method	Countries
Gift cards	International

Wallets

Payment method	Countries
Amazon Pay	Depends on business location
Apple Pay	International
Bancontact mobile(via card component)	BE
Google Pay	International
MOLPay	International
Paytm	IN
PayPal	International
Wallets India	IN
UPI	IN

---

Installation Instructions

Before getting started

Before you begin to integrate, make sure you have followed the Get started with Adyen guide to:

• Get an overview of the steps needed to accept live payments.
• Create your test account. While you wait for your application for a live account to be approved, you can start your integration using your test account.

If your application is approved, follow our go-live checklist to make sure you've got everything set up correctly.

Set-up the plugin

To use the Adyen payments plugin for SAP Commerce, you need to install the plugin and configure it in your SAP back office and in the Adyen Customer Area.

Adyen's payments plugin 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"/>

To configure the Adyen notification service, add:

<extension dir="${HYBRIS_BIN_DIR}/custom/adyen-hybris/adyenv6notification"/>

If you are using yacceleratorordermanagement (b2c_acc_oms recipe for 6.x and b2c_b2b_acc_oms for 1905), also add:

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

If you are using yacceleratorfulfilment (b2c_acc recipe for 6.x and b2c_acc_plus_ for 1905), also add:

<extension dir="${HYBRIS_BIN_DIR}/custom/adyen-hybris/adyenv6fulfilmentprocess"/>

5. Modify the config/local.properties file:

• Append ,/[^/]+(/[^?])+(adyen-response)$,/adyen(/[^?])+$ to the csrf.allowed.url.patterns value.
• Add is3DS2allowed = true.

6. Install the Adyen plugin into your existing storefront template: cd bin/platform

. ./setantenv.sh

ant addoninstall -Daddonnames="adyenv6b2ccheckoutaddon" -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"

ant clean all

Configure the plugin

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

Account settings

Fill out the following fields:

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

Enable Guest Checkout Tokenization - Select True if you want to enable tokenization of card payment details of guest users. Default is false.

_Region selector _ - The region selected for your merchant data center.

API settings

For authenticating API requests from your SAP back office, you need to set up an API key.

You first need to set up an API key in your Adyen Customer Area:

1. Log in to your Customer Area.
2. Go to Developers > API credentials, and select the API credential username for your integration, for example ws@Company.[YourCompanyAccount].
3. Under Server settings > Authentication select the API key tab.
4. Select Generate API key.
5. Select the copy icon and store your API key securely in your system.
6. Select Save changes.

Then fill out the following fields in your SAP back office:

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.

Client key settings

When using the plugin on versions 9.0.0 and above, you need to set up client key for client-side authentication. The client key is linked to your API credential and a list of domains from which we expect to get your client-side requests.

You first need to set up a client key in your Adyen Customer Area:

1. Log in to your Customer Area.
2. Go to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].
3. Under Client settings > Authentication select the Client key tab.
4. Select Generate client key.
5. Select the copy icon and store your client key securely in your system.
6. Under Add allowed origins, enter your domains and select Add.
7. Select Save changes.

Then fill out the following field in your SAP back office:

Web Service User Client Key - The client key from your Adyen Customer Area.

Additional data in API response settings

To process the response received from Adyen, you need to configure your merchant account to include additional data in the API response.

1. Log in to your Customer Area with your merchant-level account.
2. Go to Developers > API URLs.
3. In the Additional data in API response section, select the following fields:

• Variant: Required. This provides the payment method in the response.
• Acquirer result: This provides additional information such as AuthCode and AvsResult.
• Cardholder name
• Card bin
• Card summary
• Expiry date
• 3D Secure result: This provides 3D Secure-related information.
• Fraud result: This provides fraud check results.

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 Customer Area.
2. Select Developers > Webhooks.
3. Select + Webhook.
4. Under Recommended webhooks > Standard notification select Add.
5. Select the toggle to make the standard notification Enabled.
6. Select the edit icon for Server configuration.
7. Enter:

• URL: Your website URL followed by adyenv6notification/adyen/v6/notification/[SiteId]/json.
• Method: JSON
• SSL Version: TLSv1.2 Select Apply.

8. Under Security > Basic authentication, select the edit icon . Enter your server's username and password. Select Apply.
9. Select Save changes.

Then fill out the following fields in your SAP back office:

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 Customer Area.
2. Select Developers > Webhooks.
3. Select the edit icon for the webhook you wish to test.
4. Select Test configuration.
5. Select the notifications you want to test.
6. Select Test to run the test. You can use the icon to see the details of the test notification that was sent.

Point of sale (POS) settings

To configure the plugin for in-person payments, fill out the following fields in your SAP back office:

POS Merchant Account - The name of your Adyen merchant account for which the point of sale transactions will be processed. You can find this in the upper-right corner of your Customer Area. This can be the same merchant account that you added under Account settings.

POS API Key - The API key associated with your merchant account for point of sale. For instructions on how to find this, refer to API settings.

POS Store ID - The ID of your store for processing point of sale payments. To find this, log in to your Customer Area with your merchant account, and go to Point of sale > Stores.

Recurring contract type - If you want to save the payment details of an in-store shopper, you need to choose the type of recurring contract that you want to use:

• NONE – Do not enable stored payment methods.
• 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.

To find the payment receipt for a point-of-sale transaction:

1. Log in to your SAP back office.
2. Go to the Orders section, and click on the transaction.
3. Go to the PAYMENT AND DELIVERY tab, and select PaymentInfo.

This opens a new window containing the POS Receipt field.

Boleto

To accept Boleto payments:

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

PayPal

To accept PayPal payments, you need to add your PayPal Merchant ID to your configuration:

1. Follow the steps in Obtaining your PayPal Merchant ID to find your PayPal Merchant ID.
2. In your SAP back office, go to the Advanced Settings section.
3. In the PayPal Merchant ID field, enter your ID.