{"title":"Set up the add-on","category":"default","creationDate":1681806720,"content":"<p>To use the Adyen payments add-on for SAP Commerce, you need to install the add-on and configure it in your SAP back office and in the Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<h2 id=\"before-you-begin\">Requirements<\/h2>\n<p>Make sure that you have created a test account with Adyen.\u00a0With this, you'll be able to access the\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">test Customer Area<\/a>, and <a href=\"\/get-started-with-adyen\/application-requirements\">apply for a live account<\/a>. While you wait for your live account credentials, you can start integrating by using your test account.\u00a0<\/p>\n<h2 id=\"install-the-add-on\">Install the add-on<\/h2>\n<p>Adyen's payments add-on for SAP Commerce is open-source and available on\u00a0<a href=\"https:\/\/github.com\/Adyen\/adyen-hybris\/tree\/master\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>. To install it:<\/p>\n<ol>\n<li>\n<p>Download the latest version available on\u00a0<a href=\"https:\/\/github.com\/Adyen\/adyen-hybris\/tree\/master\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>.<\/p>\n<\/li>\n<li>\n<p>Copy the files to:\u00a0<strong>${HYBRIS_BIN_DIR}\u00a0<\/strong>&gt;<strong>\u00a0Custom<\/strong>\u00a0&gt;<strong>\u00a0[YourHybrisInstallationFolder]<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Verify the folder and file permissions of the copied files.<\/p>\n<\/li>\n<li>\n<p>Add the Adyen extensions\u00a0to the\u00a0<strong>config\/localextensions.xml<\/strong>\u00a0file:<\/p>\n<pre><code>&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6core\"\/&gt;\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6b2ccheckoutaddon\"\/&gt;\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6backoffice\"\/&gt;<\/code><\/pre>\n<p>To configure the Adyen notification service, add:<\/p>\n<pre><code class=\"language-xml\">&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyen-hybris\/adyenv6notification\"\/&gt;<\/code><\/pre>\n<p>If you are using\u00a0<strong>yacceleratorordermanagement<\/strong> (<strong>b2c_acc_oms<\/strong> recipe for 6.x and <strong>b2c_b2b_acc_oms<\/strong> for 1905), also add:<\/p>\n<pre><code class=\"language-xml\">&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6ordermanagement\"\/&gt;<\/code><\/pre>\n<p>If you are using\u00a0<strong>yacceleratorfulfilment<\/strong> (<strong>b2c_acc<\/strong> recipe for 6.x and <strong>b2c_acc_plus_<\/strong> for 1905), also add:<\/p>\n<pre><code class=\"language-xml\">&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyen-hybris\/adyenv6fulfilmentprocess\"\/&gt;<\/code><\/pre>\n<\/li>\n<li>\n<p>Modify the <strong>config\/local.properties<\/strong> file:<\/p>\n<ul>\n<li>Append <code>,\/[^\/]+(\/[^?]*)+(adyen-response)$,\/adyen(\/[^?]*)+$<\/code> to the <code>csrf.allowed.url.patterns<\/code> value.<\/li>\n<li>Add <code>is3DS2allowed = true<\/code>.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Install the Adyen add-on into your existing storefront template:<\/p>\n<pre><code class=\"language-bash\">cd bin\/platform\n. .\/setantenv.sh\nant addoninstall -Daddonnames=\"adyenv6b2ccheckoutaddon\" -DaddonStorefront.yacceleratorstorefront=\"yacceleratorstorefront\"\nant clean all<\/code><\/pre>\n<\/li>\n<\/ol>\n<h2 id=\"configure-the-add-on\">Configure the add-on<\/h2>\n<ol>\n<li>Log in to your SAP back office<\/li>\n<li>Go to <strong>BaseStore<\/strong>\u00a0&gt;\u00a0<strong>Adyen<\/strong>.\u00a0<br \/>\nThis opens a page with settings for the Adyen add-on.\u00a0<\/li>\n<li>Configure the settings by following the instructions below.<\/li>\n<\/ol>\n<h3 id=\"account-settings\">Account settings<\/h3>\n<p>Fill out the following fields:<\/p>\n<table><colgroup><col style=\"width: 20%\"><col style=\"width: 79%\"><\/colgroup><thead><tr class=\"header\"><th>Field name<\/th><th>\u00a0Instruction<\/th><\/tr><\/thead><tbody><tr><td>\n<p><strong>Merchant account name<\/strong><\/p>\n<\/td><td>\n<p>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\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<\/td><\/tr><tr><td>\n<p><strong>Immediate capture flow<\/strong><\/p>\n<\/td><td>\n<p>This has to match the <a href=\"\/online-payments\/capture\">capture delay<\/a> that you set in the Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<div class=\"sc-notice info\"><div>If you set\u00a0<strong>Capture Delay<\/strong>\u00a0to\u00a0<strong>manual<\/strong>, set\u00a0<strong>Immediate capture flow<\/strong>\u00a0to\u00a0<strong>False<\/strong>. Otherwise, set\u00a0<strong>Immediate capture flow<\/strong>\u00a0to\u00a0<strong>True<\/strong>.<\/div><\/div>To set the capture delay in the Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>:<ol><li markdown=\"1\">Log in to your Adyen\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li><li markdown=\"1\">Go to\u00a0<strong>Settings<\/strong>\u00a0&gt;\u00a0<strong>Account settings<\/strong>.<\/li><li markdown=\"1\">In the\u00a0<strong>Capture Delay<\/strong>\u00a0drop-down menu, select one of the following:\u00a0<br><ul><li markdown=\"1\"><strong>immediate<\/strong>\u00a0if you want payments to be captured immediately after authorisation (this is the default setting).<\/li><li markdown=\"1\">the number of days between authorisation and automatic capture.<\/li><li markdown=\"1\"><strong>manual<\/strong>\u00a0if you want to capture all payments manually from the SAP back office.<\/li><\/ul><\/li><li markdown=\"1\">Select\u00a0<strong>Submit<\/strong>.<\/li><\/ol><\/p>\n<\/td><\/tr><tr><td>\n<p><strong>Allowed Credit Card Types<\/strong><\/p>\n<\/td><td>\n<p>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\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<\/td><\/tr><tr><td>\n<p><strong>Recurring contract type<\/strong><\/p>\n<\/td><td>\n<p>Select the <a href=\"\/online-payments\/tokenization\/make-token-payments\">type of recurring transactions<\/a> that you want to enable. Possible values:<ul><li markdown=\"1\"><strong>RECURRING<\/strong>\u00a0\u00a0\u2013\u00a0Enable stored payment methods for\u00a0<em>shopper-not-present<\/em> transactions.<\/li><li markdown=\"1\"><strong>ONECLICK<\/strong>\u00a0\u2013\u00a0Enable stored payment methods for <em>shopper-present<\/em> transactions. For credit cards, the\u00a0shopper needs to enter their CVC\/CVV to complete the payment.<\/li><li markdown=\"1\"><strong>RECURRING<\/strong>,<strong>ONECLICK<\/strong>\u00a0\u2013\u00a0Enable stored payment methods for <em>both<\/em> shopper-present and shopper-not-present transactions.<\/li><\/ul><\/p>\n<\/td><\/tr><tr><td>\n<p>\u00a0<strong>Adyen Test mode<\/strong><\/p>\n<\/td><td>\n<p>Select <strong>True<\/strong>\u00a0if you are using the Adyen test environment, and\u00a0<strong>False<\/strong>\u00a0if you are using the Adyen live environment.<\/p>\n<\/td><\/tr><tr><td>\n<p><strong>Enable Guest Checkout Tokenization<\/strong><\/p>\n<\/td><td>\n<p>Select <strong>True<\/strong> if you want to enable tokenization of card payment details of guest users. Default is false.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h3 id=\"api-settings\">API settings<\/h3>\n<p>For authenticating API requests from your SAP back office, you need to set up\u00a0an API key.\u00a0<\/p>\n<p>You first need to set up an API key in your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> and select your <strong>Company<\/strong> account.<\/li>\n<li>Go to <strong>Developers<\/strong> &gt; <strong>API credentials<\/strong>.<\/li>\n<li>Select the <strong>Payments<\/strong> or <strong>Platforms<\/strong> tab, depending on your integration type.<\/li>\n<li>Select the credential username.<\/li>\n<li>Under <strong>Server settings<\/strong> &gt; <strong>Authentication<\/strong> select the <strong>API key<\/strong> tab.<\/li>\n<li>Select <strong>Generate API key<\/strong>.<\/li>\n<li>Select the copy icon <i class=\"adl-icon-copy\"><\/i> and store your API key securely in your system.\n<div class=\"notices yellow\">\n<p>You cannot copy the API key again after you leave the page.<\/p>\n<\/div><\/li>\n<li>Select <strong>Save changes<\/strong>.<\/li>\n<\/ol>\n<p>Then fill out the following fields in your SAP back office:<\/p>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 21%\"><col style=\"width: 78%\"><\/colgroup><thead><tr class=\"header\"><th>Field<\/th><th>Instruction<\/th><\/tr><\/thead><tbody><tr><td>\n<p><strong>API Endpoint URL Prefix<\/strong><\/p>\n<\/td><td>\n<p>The prefix for your live URL. Get it\u00a0from your Adyen <a href=\"https:\/\/ca-live.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">live Customer Area<\/a>\u00a0&gt; <strong>Developers<\/strong> &gt;\u00a0<strong>API URLs<\/strong> &gt;\u00a0<strong>Prefix<\/strong>. <br> This field is only required if you are using the live environment.<\/p>\n<\/td><\/tr><tr><td>\n<p><strong>Web Service User API Key<\/strong><\/p>\n<\/td><td>\n<p>The API key from your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h3 id=\"client-key-settings\">Client key settings<\/h3>\n<p>When using the plugin on versions 9.0.0 and above, you need to set up <a href=\"\/development-resources\/client-side-authentication\">client key<\/a> 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.<\/p>\n<p>You first need to set up a client key in your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Go to <strong>Developers<\/strong> &gt; <strong>API credentials<\/strong>, and select the credential username for your integration, for example <strong>ws@Company.[YourCompanyAccount]<\/strong>.<\/li>\n<li>Under <strong>Client settings<\/strong> &gt; <strong>Authentication<\/strong> select the <strong>Client key<\/strong> tab.<\/li>\n<li>Select <strong>Generate client key<\/strong>.<\/li>\n<li>Select the copy icon <i class=\"adl-icon-copy\"><\/i> and store your client key securely in your system.<\/li>\n<li>Under <strong>Add allowed origins<\/strong>, enter your <a href=\"\/development-resources\/client-side-authentication#allowed-origins\">domains<\/a> and select <strong>Add<\/strong>.<\/li>\n<li>Select <strong>Save changes<\/strong>.<\/li>\n<\/ol>\n<p>Then fill out the following field in your SAP back office:<\/p>\n<table style=\"width:100%;\"><colgroup><col style=\"width: 21%\"><col style=\"width: 78%\"><\/colgroup><thead><tr class=\"header\"><th>Field<\/th><th>Instruction<\/th><\/tr><\/thead><tbody><tr><td>\n<p><strong>Web Service User Client Key<\/strong><\/p>\n<\/td><td>\n<p>The client key from your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h4 id=\"additional-data-settings\">Additional data in API response settings<\/h4>\n<p>To process the response received from Adyen, you need to configure your merchant account to include additional data in the API response.<\/p>\n<ol>\n<li>Log in to your\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>\u00a0with your merchant account.<\/li>\n<li>Go to\u00a0<strong>Developers<\/strong>\u00a0&gt; <strong>API URLs<\/strong>.<\/li>\n<li>\n<p>In the <strong>Additional data in API response<\/strong> section, select the following fields:<\/p>\n<ul>\n<li><strong>Variant<\/strong>: Required. This provides the payment method in the response.<\/li>\n<li><strong>Acquirer result<\/strong>: This provides additional information such as AuthCode and AvsResult.<\/li>\n<li><strong>Cardholder name<\/strong><\/li>\n<li><strong>Card bin<\/strong><\/li>\n<li><strong>Card summary<\/strong><\/li>\n<li><strong>Expiry date<\/strong><\/li>\n<li><strong>3D Secure result<\/strong>: This provides 3D Secure-related information.<\/li>\n<li><strong>Fraud result<\/strong>: This provides fraud check results.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<h3 id=\"server-notification-settings\">Server notification settings<\/h3>\n<p>To\u00a0inform your SAP back office of payment status changes, Adyen uses\u00a0<a href=\"\/development-resources\/webhooks\">webhooks<\/a>, sent as HTTP callbacks to endpoints on your server.<\/p>\n<p>You first need to set up webhooks in your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Select <strong>Developers<\/strong> &gt; <strong>Webhooks<\/strong>.<\/li>\n<li>Select <strong>+ Webhook<\/strong>.<\/li>\n<li>Under <strong>Recommended webhooks<\/strong> &gt; <strong>Standard webhook<\/strong> select <strong>Add<\/strong>.<\/li>\n<li>Select the toggle to make the standard webhook <strong>Enabled<\/strong>.<\/li>\n<li>Select the edit icon <i class=\"adl-icon-edit\"><\/i> for <strong>Server configuration<\/strong>.<\/li>\n<li>Enter:\n<ul>\n<li><strong>URL<\/strong>: Your website URL followed by <strong>adyenv6notification\/adyen\/v6\/notification\/[SiteId]\/json<\/strong>.<\/li>\n<li><strong>Method<\/strong>: JSON<\/li>\n<li><strong>SSL Version<\/strong>: TLSv1.2<br \/>\nSelect <strong>Apply<\/strong>.<\/li>\n<\/ul><\/li>\n<li>Under <strong>Security<\/strong> &gt; <strong>Basic authentication<\/strong>, select the edit icon <i class=\"adl-icon-edit\"><\/i>. Enter your server's username and password. Select <strong>Apply<\/strong>.<\/li>\n<li>Select <strong>Save changes<\/strong>.<\/li>\n<\/ol>\n<p>Then fill out the following fields in your SAP back office:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: left;\">Instruction<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Server Communication HTTP Basic username<\/strong><\/td>\n<td style=\"text-align: left;\">The username for notifications from your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Server Communication HTTP Basic password<\/strong><\/td>\n<td style=\"text-align: left;\">The password for notifications from your Adyen <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"test-notifications\">Test webhooks<\/h4>\n<p>To test whether webhooks have been configured correctly:\u00a0<\/p>\n<p>Your server must <a href=\"#accept-webhooks\">acknowledge webhooks with a successful HTTP response status code (like <strong>202<\/strong>)<\/a>.<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Select <strong>Developers<\/strong> &gt; <strong>Webhooks<\/strong>.<\/li>\n<li>Select the webhook to test.<br \/>\nThe <strong>Webhook details<\/strong> panel includes information about the configuration. Under <strong>Events<\/strong>, you can find the configured event types that you can test for this webhook.<\/li>\n<li>Select the edit <i class=\"adl-icon-edit\"><\/i> icon<\/li>\n<li>Select <strong>Test configuration<\/strong>.<\/li>\n<li>If you are on a <a href=\"\/account\/account-structure#company-account\">company account<\/a>, select a <strong>Merchant account<\/strong> from the dropdown list.<\/li>\n<li>In the <strong>Event<\/strong> dropdown list, select the <a href=\"\/development-resources\/webhooks\/webhook-types#event-codes\">event type<\/a> to test webhooks for.<\/li>\n<\/ol>\n<p>If the test webhook failed, you get an error message with the reason. <a href=\"\/development-resources\/webhooks\/troubleshoot\">Troubleshoot the problem<\/a>.<\/p>\n<h3 id=\"pos-settings\">Point of sale (POS) settings<\/h3>\n<p>To configure the add-on for in-person payments, fill out the following fields in your SAP back office:<\/p>\n<table><colgroup><col style=\"width: 20%\"><col style=\"width: 79%\"><\/colgroup><thead><tr class=\"header\"><th>Field name<\/th><th> Instruction<\/th><\/tr><\/thead><tbody><tr><td>\n<p><strong>POS Merchant Account<\/strong><\/p>\n<\/td><td>\n<p>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 <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>. This can be the same merchant account that you added under <b>Account settings<\/b>.<\/p>\n<\/td><\/tr>\n\n<tr><td>\n<p><strong>POS API Key<\/strong><\/p>\n<\/td><td>\n<p>The API key associated with your merchant account for point of sale. For instructions on how to find this, refer to <a href=\"#api-settings\">API settings<\/a>.<\/p>\n<\/td><\/tr>\n<tr><td>\n<p><strong>POS Store ID<\/strong><\/p>\n<\/td><td>\n<p>The ID of your store for processing point of sale payments. To find this, log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> with your merchant account, and go to <b>Point of sale<\/b> &gt; <b>Stores<\/b>.<\/p>\n<\/td><\/tr>\n\n<tr><td>\n<p><strong>Recurring contract type<\/strong><\/p>\n<\/td><td>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:\n    <ul><li>\n<p><strong>NONE<\/strong>  \u2013 Do not enable stored payment methods.<\/p>\n<\/li>\n        <li>\n<p><strong>RECURRING<\/strong>  \u2013 Enable stored payment methods for <em>shopper-not-present<\/em> transactions.<\/p>\n<\/li><li>\n<p><strong>ONECLICK<\/strong> \u2013 Enable stored payment methods for <em>shopper-present<\/em> transactions. For credit cards, the shopper needs to enter their CVC\/CVV to complete the payment.<\/p>\n<\/li>\n        <li>\n<p><strong>RECURRING<\/strong>,<strong>ONECLICK<\/strong> \u2013 Enable stored payment methods for <em>both<\/em> shopper-present and shopper-not-present transactions.<\/p>\n<\/li><\/ul><\/td><\/tr>\n<\/tbody><\/table>\n<p>To find the payment receipt for a point-of-sale transaction:<\/p>\n<ol>\n<li>Log in to your SAP back office.<\/li>\n<li>Go to the <strong>Orders<\/strong> section, and click on the transaction.<\/li>\n<li>Go to the <strong>PAYMENT AND DELIVERY<\/strong> tab, and select <strong>PaymentInfo<\/strong>.<br \/>\nThis opens a new window containing the <strong>POS Receipt<\/strong> field.<\/li>\n<\/ol>\n<h3 id=\"boleto\">Boleto<\/h3>\n<p>To accept <a href=\"\/payment-methods\/boleto-bancario\">Boleto<\/a> payments:<\/p>\n<ol>\n<li>In your SAP back office, go to the <strong>Advanced Settings<\/strong> section.<\/li>\n<li>Set <strong>Enable Boleto<\/strong> to <strong>True<\/strong>.<\/li>\n<\/ol>\n<h3 id=\"paypal\">PayPal<\/h3>\n<p>To accept <a href=\"\/payment-methods\/paypal\">PayPal<\/a> payments, you need to add your PayPal Merchant ID to your configuration:<\/p>\n<ol>\n<li>Follow the steps in <a href=\"\/payment-methods\/paypal\/setup-paypal-direct-merchants\/fallback-manual-setup\/#paypal-merchant-id\">Obtaining your PayPal Merchant ID<\/a><br \/>\nto find your PayPal Merchant ID.<\/li>\n<li>In your SAP back office, go to the <strong>Advanced Settings<\/strong> section.<\/li>\n<li>In the <strong>PayPal Merchant ID<\/strong> field, enter your ID.<\/li>\n<\/ol>","url":"https:\/\/docs.adyen.com\/plugins\/hybris\/set-up-the-add-on","articleFields":{"description":"Install and configure the Adyen payments add-on for SAP Commerce.","feedback_component":true,"next_steps":[{"title":"Test your integration","description":"Use our test card numbers to make test payments.","url":"\/development-resources\/test-cards-and-credentials\/test-card-numbers","required":true},{"title":"Configure your live account","description":"Follow this checklist before you start accepting live payments.","url":"\/plugins\/hybris\/go-live-checklist","required":true}],"id":"47483532","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"18-04-2023 10:32","filters_component":false},"algolia":{"url":"https:\/\/docs.adyen.com\/plugins\/hybris\/set-up-the-add-on","title":"Set up the add-on","content":"To use the Adyen payments add-on for SAP Commerce, you need to install the add-on and configure it in your SAP back office and in the Adyen Customer Area.\nRequirements\nMake sure that you have created a test account with Adyen.\u00a0With this, you'll be able to access the\u00a0test 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.\u00a0\nInstall the add-on\nAdyen's payments add-on for SAP Commerce is open-source and available on\u00a0GitHub. To install it:\n\n\nDownload the latest version available on\u00a0GitHub.\n\n\nCopy the files to:\u00a0${HYBRIS_BIN_DIR}\u00a0&gt;\u00a0Custom\u00a0&gt;\u00a0[YourHybrisInstallationFolder].\n\n\nVerify the folder and file permissions of the copied files.\n\n\nAdd the Adyen extensions\u00a0to the\u00a0config\/localextensions.xml\u00a0file:\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6core\"\/&gt;\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6b2ccheckoutaddon\"\/&gt;\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6backoffice\"\/&gt;\nTo configure the Adyen notification service, add:\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyen-hybris\/adyenv6notification\"\/&gt;\nIf you are using\u00a0yacceleratorordermanagement (b2c_acc_oms recipe for 6.x and b2c_b2b_acc_oms for 1905), also add:\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyenv6ordermanagement\"\/&gt;\nIf you are using\u00a0yacceleratorfulfilment (b2c_acc recipe for 6.x and b2c_acc_plus_ for 1905), also add:\n&lt;extension dir=\"${HYBRIS_BIN_DIR}\/custom\/adyen-hybris\/adyenv6fulfilmentprocess\"\/&gt;\n\n\nModify the config\/local.properties file:\n\nAppend ,\/[^\/]+(\/[^?]*)+(adyen-response)$,\/adyen(\/[^?]*)+$ to the csrf.allowed.url.patterns value.\nAdd is3DS2allowed = true.\n\n\n\nInstall the Adyen add-on into your existing storefront template:\ncd bin\/platform\n. .\/setantenv.sh\nant addoninstall -Daddonnames=\"adyenv6b2ccheckoutaddon\" -DaddonStorefront.yacceleratorstorefront=\"yacceleratorstorefront\"\nant clean all\n\n\nConfigure the add-on\n\nLog in to your SAP back office\nGo to BaseStore\u00a0&gt;\u00a0Adyen.\u00a0\nThis opens a page with settings for the Adyen add-on.\u00a0\nConfigure the settings by following the instructions below.\n\nAccount settings\nFill out the following fields:\nField name\u00a0Instruction\nMerchant account name\n\nThe name of your Adyen merchant account for which the payments will be processed. You can find this in the upper-right corner of your\u00a0Customer Area.\n\nImmediate capture flow\n\nThis has to match the capture delay that you set in the Adyen Customer Area.If you set\u00a0Capture Delay\u00a0to\u00a0manual, set\u00a0Immediate capture flow\u00a0to\u00a0False. Otherwise, set\u00a0Immediate capture flow\u00a0to\u00a0True.To set the capture delay in the Adyen Customer Area:Log in to your Adyen\u00a0Customer Area.Go to\u00a0Settings\u00a0&gt;\u00a0Account settings.In the\u00a0Capture Delay\u00a0drop-down menu, select one of the following:\u00a0immediate\u00a0if you want payments to be captured immediately after authorisation (this is the default setting).the number of days between authorisation and automatic capture.manual\u00a0if you want to capture all payments manually from the SAP back office.Select\u00a0Submit.\n\nAllowed Credit Card Types\n\nSelect which credit card types you want to allow in the checkout form. You also need to enable these credit card types in the Adyen\u00a0Customer Area.\n\nRecurring contract type\n\nSelect the type of recurring transactions that you want to enable. Possible values:RECURRING\u00a0\u00a0\u2013\u00a0Enable stored payment methods for\u00a0shopper-not-present transactions.ONECLICK\u00a0\u2013\u00a0Enable stored payment methods for shopper-present transactions. For credit cards, the\u00a0shopper needs to enter their CVC\/CVV to complete the payment.RECURRING,ONECLICK\u00a0\u2013\u00a0Enable stored payment methods for both shopper-present and shopper-not-present transactions.\n\n\u00a0Adyen Test mode\n\nSelect True\u00a0if you are using the Adyen test environment, and\u00a0False\u00a0if you are using the Adyen live environment.\n\nEnable Guest Checkout Tokenization\n\nSelect True if you want to enable tokenization of card payment details of guest users. Default is false.\n\nAPI settings\nFor authenticating API requests from your SAP back office, you need to set up\u00a0an API key.\u00a0\nYou first need to set up an API key in your Adyen Customer Area:\n\nLog in to your Customer Area and select your Company account.\nGo to Developers &gt; API credentials.\nSelect the Payments or Platforms tab, depending on your integration type.\nSelect the credential username.\nUnder Server settings &gt; Authentication select the API key tab.\nSelect Generate API key.\nSelect the copy icon  and store your API key securely in your system.\n\nYou cannot copy the API key again after you leave the page.\n\nSelect Save changes.\n\nThen fill out the following fields in your SAP back office:\nFieldInstruction\nAPI Endpoint URL Prefix\n\nThe prefix for your live URL. Get it\u00a0from your Adyen live Customer Area\u00a0&gt; Developers &gt;\u00a0API URLs &gt;\u00a0Prefix.  This field is only required if you are using the live environment.\n\nWeb Service User API Key\n\nThe API key from your Adyen Customer Area.\n\nClient key settings\nWhen 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.\nYou first need to set up a client key in your Adyen Customer Area:\n\nLog in to your Customer Area.\nGo to Developers &gt; API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].\nUnder Client settings &gt; Authentication select the Client key tab.\nSelect Generate client key.\nSelect the copy icon  and store your client key securely in your system.\nUnder Add allowed origins, enter your domains and select Add.\nSelect Save changes.\n\nThen fill out the following field in your SAP back office:\nFieldInstruction\nWeb Service User Client Key\n\nThe client key from your Adyen Customer Area.\n\nAdditional data in API response settings\nTo process the response received from Adyen, you need to configure your merchant account to include additional data in the API response.\n\nLog in to your\u00a0Customer Area\u00a0with your merchant account.\nGo to\u00a0Developers\u00a0&gt; API URLs.\n\nIn the Additional data in API response section, select the following fields:\n\nVariant: Required. This provides the payment method in the response.\nAcquirer result: This provides additional information such as AuthCode and AvsResult.\nCardholder name\nCard bin\nCard summary\nExpiry date\n3D Secure result: This provides 3D Secure-related information.\nFraud result: This provides fraud check results.\n\n\n\nServer notification settings\nTo\u00a0inform your SAP back office of payment status changes, Adyen uses\u00a0webhooks, sent as HTTP callbacks to endpoints on your server.\nYou first need to set up webhooks in your Adyen Customer Area.\n\nLog in to your Customer Area.\nSelect Developers &gt; Webhooks.\nSelect + Webhook.\nUnder Recommended webhooks &gt; Standard webhook select Add.\nSelect the toggle to make the standard webhook Enabled.\nSelect the edit icon  for Server configuration.\nEnter:\n\nURL: Your website URL followed by adyenv6notification\/adyen\/v6\/notification\/[SiteId]\/json.\nMethod: JSON\nSSL Version: TLSv1.2\nSelect Apply.\n\nUnder Security &gt; Basic authentication, select the edit icon . Enter your server's username and password. Select Apply.\nSelect Save changes.\n\nThen fill out the following fields in your SAP back office:\n\n\n\nField\nInstruction\n\n\n\n\nServer Communication HTTP Basic username\nThe username for notifications from your Adyen Customer Area.\n\n\nServer Communication HTTP Basic password\nThe password for notifications from your Adyen Customer Area.\n\n\n\nTest webhooks\nTo test whether webhooks have been configured correctly:\u00a0\nYour server must acknowledge webhooks with a successful HTTP response status code (like 202).\n\nLog in to your Customer Area.\nSelect Developers &gt; Webhooks.\nSelect the webhook to test.\nThe Webhook details panel includes information about the configuration. Under Events, you can find the configured event types that you can test for this webhook.\nSelect the edit  icon\nSelect Test configuration.\nIf you are on a company account, select a Merchant account from the dropdown list.\nIn the Event dropdown list, select the event type to test webhooks for.\n\nIf the test webhook failed, you get an error message with the reason. Troubleshoot the problem.\nPoint of sale (POS) settings\nTo configure the add-on for in-person payments, fill out the following fields in your SAP back office:\nField name Instruction\nPOS Merchant Account\n\nThe 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.\n\n\n\nPOS API Key\n\nThe API key associated with your merchant account for point of sale. For instructions on how to find this, refer to API settings.\n\n\nPOS Store ID\n\nThe 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 &gt; Stores.\n\n\n\nRecurring contract type\nIf 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:\n    \nNONE  \u2013 Do not enable stored payment methods.\n\n        \nRECURRING  \u2013 Enable stored payment methods for shopper-not-present transactions.\n\nONECLICK \u2013 Enable stored payment methods for shopper-present transactions. For credit cards, the shopper needs to enter their CVC\/CVV to complete the payment.\n\n        \nRECURRING,ONECLICK \u2013 Enable stored payment methods for both shopper-present and shopper-not-present transactions.\n\n\nTo find the payment receipt for a point-of-sale transaction:\n\nLog in to your SAP back office.\nGo to the Orders section, and click on the transaction.\nGo to the PAYMENT AND DELIVERY tab, and select PaymentInfo.\nThis opens a new window containing the POS Receipt field.\n\nBoleto\nTo accept Boleto payments:\n\nIn your SAP back office, go to the Advanced Settings section.\nSet Enable Boleto to True.\n\nPayPal\nTo accept PayPal payments, you need to add your PayPal Merchant ID to your configuration:\n\nFollow the steps in Obtaining your PayPal Merchant ID\nto find your PayPal Merchant ID.\nIn your SAP back office, go to the Advanced Settings section.\nIn the PayPal Merchant ID field, enter your ID.\n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"SAP Commerce (Hybris)","lvl3":"Set up the add-on"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/plugins","lvl2":"https:\/\/docs.adyen.com\/plugins\/hybris","lvl3":"\/plugins\/hybris\/set-up-the-add-on"},"levels":4,"category":"Plugins","category_color":"green","tags":["add-on"]}}
