{"title":"Set up the cartridge","category":"default","creationDate":1776961628,"content":"
\n \n <\/in-page-filtering>\n<\/div>\n
\n \n <\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge","articleFields":{"description":"Set up the cartridge in the Adyen Customer Area and in the Salesforce Business Manager.","feedback_component":true,"next_steps":[{"title":"Set up payment methods","description":"Configure the payment methods that you want to offer in your Salesforce Commerce Cloud store.","url":"\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-payment-methods","required":true},{"title":"Configure your live account","description":"Follow this checklist before you start accepting live payments.","url":"\/plugins\/salesforce-commerce-cloud\/sfra\/go-live-checklist","required":true}],"filters_component":true,"filters_config_folder":"salesforce","dynamic_minitoc":true,"dynamic_minitoc_context":".in-page-filtering--content"},"algolia":[{"url":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge","title":"Set up the cartridge","content":"Requirements\nBefore you begin, make sure that you have performed the following steps:\n\nCreate a test account with Adyen. With this, you will 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.\nFinish the metadata import.\n\nIn Salesforce Commerce Cloud, enforce HTTPS.\n\nTo be compatible with the Chrome v80 Cookie policy, you need to enforce the use of HTTPS for all sites.\n\u00a0\n\n\nAccount structure\nWith Adyen, you have a single company account, and one or more sub-accounts called merchant accounts. However, in Salesforce, you can only have one merchant account for each storefront.Step 1: Set up the cartridge path\nTo set up the cartridge path in the Business Manager:\u00a0\n\n\nGo to\u00a0Administration\u00a0>\u00a0Sites\u00a0>\u00a0Manage Sites\u00a0>\u00a0[yourSite]\u00a0>\u00a0Settings.\u00a0\n\n\nIn the\u00a0Cartridges\u00a0box, enter:\napp_adyen_SFRA:int_adyen_SFRA:int_adyen_webhooks:app_storefront_base\nIf you are using any form of customizations, make sure to follow our customization guide on best practices around customizations.\n\n\nSelect Apply.\n\nStep 2: Enable the Salesforce Business Manager configuration page\nTo show the Adyen Settings menu item in your Salesforce Business Manager:\n\nGo to Administration > Sites > Manage Sites > Business Manager - Settings.\nIn the Cartridges box, enter bm_adyen:int_adyen_SFRA:app_storefront_base. Select Apply.\nGo to Administration > Organization > Roles & Permissions > Administrator - Business Manager Modules.\nIn the dialogue box, select the site you want to enable Adyen for or select the Sites box to select all. Select Apply.\nUnder Site Preferences, find Adyen Settings in the list and select the checkbox in the right column. At the bottom of the page, select Update.\nStep 3: Generate an API key and client key\nTo connect your Commerce Cloud store to the Adyen API, you need to generate an API key in your Customer Area and add it to your Salesforce Business Manager.\nTo authenticate requests from your payment environment, the cartridge also needs a client key. You need to generate a client key in your Customer Area and add it your Salesforce Business Manager.\nGenerate an API key in your Customer Area\n\nLog in to your Customer Area and select your Company account.\nGo to Developers > API credentials.\nSelect the Payments or Platforms tab, depending on your integration type.\nSelect the credential username.\nUnder Server settings > 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\nGenerate a client key in your Customer Area\n\nLog in to your Customer Area.\nGo to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].\nUnder Client settings > 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\nAfter generating both keys, add them to your Salesforce Business Manager:\n\nIn your Salesforce Business Manager, go to Merchant Tools > Site Preferences > Adyen settings > Account settings.\nUnder Adyen Client Key, enter the client key that you generated.\nUnder API key of webservice, enter the API key that you generated.\nSelect Save Changes.\nStep 4: Set up account settings\n\n\nIn your Salesforce Business Manager, go to Merchant Tools > Site Preferences > Adyen settings > Account settings, and fill the following fields:\n\n\n\nField\nDescription\n\n\n\n\nEnvironment\nSelect Test for setting up and testing your integration. When going live, you need to change this setting to Live.\n\n\nAdyen Client Key\nThe client key that you generated.\n\n\nStorefront Reference Architecture (SFRA) - version 6 or 7\nOnly if you are using SFRA version 6 or 7, select Enable.\n\n\nMerchant Account\nThe name of your Adyen merchant account.\n\n\nAPI key of webservice\nThe API key that you generated.\n\n\n\nThe Adyen Live Prefix and Front-end resources region fields are only relevant after you have set up and tested your integration, and are ready to go live. Find the information for these fields in our go-live checklist.\n\n\nSelect Save Changes.\n\nStep 5: Set up webhooks\nTo inform your Commerce Cloud store of payment status changes, Adyen uses webhooks, sent as HTTP callbacks to endpoints on your server. To receive webhooks, you need to enter your server's details in the Customer Area, and add the webhooks credentials to the Salesforce Business Manager.\n1. Set up webhooks in the Customer Area\n\n\nIn your Customer Area, go to Developers\u00a0>\u00a0 Webhooks.\n\nWe recommend to configure webhooks for your company account. This ensures that you do not have duplicate webhook configurations, and improves performance.\n\n\n\nSelect Webhook.\n\n\nFrom the list of webhooks, next to Standard webhook, select Add.\n\n\nUnder General, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nEnabled\nSelect the toggle to enable or disable the webhook.\n\n\nVersion\nThe webhook version.\n\n\nDescription\nYour description of the webhook.\n\n\nMerchant accounts\nYou can apply the webhook to all merchant accounts for a company account, include only specific merchant accounts, or exclude specific merchant accounts for your company account.\n\n\n\n\n\nUnder Server configuration, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nURL\n- URL: Your webhook server's URL, adding \/Adyen-Notify at the end, for example: https:\/\/zzft-xx.sandbox.XXXX.dx.commercecloud.salesforce.com\/on\/demandware.store\/Sites-RefArch-Site\/default\/Adyen-Notify.\n\n\nMethod\nHTTP POST\n\n\nEncryption protocol\nTLSv.1.3\n\n\n\nUnder Security, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nBasic authentication\nEnter your server's username and password. You need to enter these credentials in the Salesforce Business Manager later.\n\n\nHMAC Key\nGenerate the HMAC Key, copy it, and store it securely in your system. You need to enter the HMAC key in the Salesforce Business Manager later. We strongly recommend that you use HMAC signatures to protect your server from unauthorised webhook events.\n\n\n\n\n\nUnder Events settings, select the event codes for this webhook. Some webhook types do not support more than one event code, so this setting does not appear.\n\n\nIf the Additional settings section is available, optionally select the additional information you want to receive in this webhook. Some webhook types do not support more than one event code, so this section does not appear.\n\n\nSelect Save configuration.\n\n\n2. Add webhook credentials to the Salesforce Business Manager\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Webhook settings.\nEnter the Webhook username and Webhook password from your Customer Area.\nOptionally, enter your HMAC Key.\nSelect Save changes.\n\n3. Test webhooks\nTo test your webhooks:\nYour server must acknowledge webhooks with a successful HTTP response status code (like 202).\n\nLog in to your Customer Area.\nSelect Developers > 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.\n4. Configure scheduled jobs\nWebhooks are stored in Commerce Cloud as custom object instances to be processed by scheduled jobs.\nAfter the metadata import, a scheduled job with ID\u00a0Process is added to the Salesforce Business Manager: \u00a0Administration\u00a0>\u00a0Operations\u00a0>\u00a0Jobs. This scheduled job has two steps (you can check this in the Job Steps tab):\u00a0\n\nProcess \u2013\u00a0Processes the webhook and updates the payment status of the order.\nClean \u2013\u00a0 Deletes the custom object instance, once it has been processed.\n\nTo optimize the processing of your instances, we recommend that you set the frequency of this scheduled job to 1 minute:\u00a0\n\nGo to the Schedule and History tab for the Process scheduled job.\nSet Trigger to Recurring Interval.\nIn the Run Time pane, set Amount to 1, and Interval to Minutes.\u00a0\nStep 6: Store shopper details\n\n \n Optional\n \n\n\nWith Adyen tokenization,\u00a0you can\u00a0securely store\u00a0payment details of your shoppers. This allows you to offer a faster checkout experience by using their stored card.\nTo set this up:\n\nIn the Salesforce Business Manager, go to\u00a0Merchant tools\u00a0>\u00a0Site Preferences\u00a0>\u00a0Adyen Settings.\nIn the Additional settings section, under Tokenisation, select Enable.\nIn the Local payment method settings section, under Store shopper details: one-click, select Enabled to securely store the payment details of your shoppers for later payments, where the shopper needs to enter their CVC\/CVV to complete the payment.\nSelect Save Changes.\nTo store payment details of guest users, go to Site Preferences > Order > Generate Customer No. for Guest Orders, and select Yes.\nSelect Apply.\n\nPayment details are stored in shopper accounts in the Salesforce platform. To be able to delete saved payment details from a shopper's account, you have to configure an additional setting. To set this up, contact our Support Team.Step 7: Set up in-person payments\n\n \n Optional\n \n\n\nYou can set up endless aisle for your physical stores to let your shoppers place ecommerce orders in your stores using payment terminals. We recommend to:\n\nCreate a separate merchant account for ecommerce and in-person payments channels that contains the stores where you will offer endless aisle. See set up your account for in-person payments to learn more about account structures.\nCreate a new SFCC site, and link it to the merchant account you created to process endless aisle payments. You can link only one SFCC site to for each merchant account.\nAdd authentication credentials for the SFCC site you created for endless aisle payments. This lets you track the store employees that are using the feature.\n\nTo process payments in your Commerce Cloud stores using payment terminals:\n\nEnable in-person payments in your Salesforce Business Manager.\nConfigure services in your Salesforce Business Manager.\nCreate a Store ID in your Adyen Customer Area.\nEnable Terminal API for the store you created in your Salesforce Business Manager.\n\nEnable in-person payments\n\nIn the Salesforce Business Manager, go to\u00a0Merchant Tools\u00a0>\u00a0Ordering\u00a0>\u00a0Payment methods.\nSelect\u00a0AdyenPOS.\nSelect\u00a0Yes\u00a0in the\u00a0Enabled\u00a0column.\nFrom\u00a0the\u00a0Payment Processor\u00a0drop-down\u00a0in the\u00a0AdyenPOS Details\u00a0section, select\u00a0Adyen_POS.\n\nConfigure services\n\nIn the Salesforce Business Manager, go to\u00a0Administration\u00a0>\u00a0Operations\u00a0>\u00a0Services.\nUnder Services, select AdyenPosPayment.\nIn the\u00a0Name\u00a0box,\u00a0enter\u00a0AdyenPosPayment.\nIn the Profile dropdown, select AdyenPOS.\nUnder Profiles, select AdyenPOS.\nIn the\u00a0Connection Timeout (ms)\u00a0box, enter\u00a0100.000.\nMake sure that the\u00a0Enable Circuit Breaker\u00a0checkbox is not selected.\n\nCreate Store ID\nIn your Adyen Customer Area, create a Store ID.\nYou can create multiple store IDs if you are going to offer endless aisle in more than one store.\nEnable Terminal API for your stores\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > In-person payments settings.\nSelect StoreID for Terminal API, and select the ID for the store you created.\n\nIf you add new stores in your Customer Area later, you must follow the steps again to enable in-person payments for the new stores you created.Step 8: Set up donations with Adyen Giving\n\n \n Optional\n \n\n\nAdyen Giving is enabled by default in your Salesforce Business Manager settings.\nIf a donation campaign is set up and active in your test Customer Area merchant account, shoppers can donate when they use a payment method that supports donations.\nTest and go live with Giving\nTest your integration by doing the following:\n\nCreate and activate a test donation campaign.\nUse our test cards to make a donation.\nGet the DONATION webhook for the donation.\n\nWhen you are ready to go live with Giving, enable the Adyen Giving merchant webhook, and create and activate a live donation campaign in your live Customer Area.\nWhen you make live donations, you can verify the outcome by either:\n\nFinding the donation in a Giving report or dashboard.\nGetting the DONATION webhook for the donation.\nStep 9: Use risk management features\n\n \n Optional\n \n\n\nOur cartridge gives you access to various risk management features that Adyen offers, to let you detect, handle, mitigate, analyze and monitor fraud.\nBasket fields\nYou can create custom risk rules to influence the risk score of a transaction. Custom risk rules are a RevenueProtect premium feature.\nYou can use Basket fields for custom risk rules. To include the Basket fields in your payment request:\n\nIn the Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Additional Settings.\nUnder Basket fields, select Enable.\nSelect Save Changes.\n\nCase management\nFor an extra layer of fraud protection, you may want to manually review a transaction before it is captured. A transaction can be sent to case management for manual review when it reaches a certain risk score, or triggers a specific risk rule.\nYou have to enable RevenueProtect premium, and configure manual review settings to use case management.\nSet up case management in the Adyen Customer Area:\n\nLog in to your Adyen Customer Area with your company account.\nAssign roles to users for manual review.\nSet a trigger for manual review.\nConfigure actions and webhooks.\nThese are the recommended Case management behavior settings for the cartridge:\nAccept: Select None and then select Send notification.\nReject: Select Cancel and then select Send notification.\nExpire: Select Cancel, and then select Reject under Notification.\nSelect Save configuration.\n\nData collection\nThe cartridge collects risk data on the checkout page and sends it to Adyen by default.\nIn addition to the data that you send when the shopper checks out, you can also optionally collect data to on any of your Salesforce ISML templates that generate your storefront pages to detect fraud outside of your checkout page.\nRefer to Collect additional data outside of the checkout page to set up data collection on any of your web pages.Step 10: Send Level 2\/3 data for cards\n\n \n Optional\n \n\n\nSending Level 2 or Level 3 Enhanced Scheme Data allows you to cut your interchange rates on US domestic transactions by up to 90 basis points. At the same time, your shoppers will see additional information about their purchase on their credit card statement.\nNot all businesses can submit Level 2\/3 data. Refer to What is Enhanced Scheme Data? for more information.\n\nSending Level 2\/3 data is supported from v20.1.3 of the cartridge.\n\nTo send Level 2\/3 data:\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Additional settings.\nUnder Level 2\/3 Data, select Enabled.\nUnder Commodity code, enter the UNSPSC commodity code for your products or services.\nSelect Save Changes.\nStep 11: Add system integrator info\n\n \n Optional\n \n\n\nIf your integration with Adyen is built by a system integrator let us know their name, so that we can offer you better support.\n\nAdding system integrator info is supported from v20.1.3 of the cartridge.\n\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Additional Settings.\nUnder System integrator, enter the name of your system integrator.\nStep 12: Configure localization\n\n \n Optional\n \n\n\nLocalization is supported in the SFCC cartridge. You can add translations for multiple locales by doing the following.\n\nOpen the translation file: int_adyen_SFRA\/config\/adyenTranslations.js.\nFor each key-value pair, add your translation. Your checkout form uses the translations for each corresponding locale.\n\nYou must not change the keys.\nRefer to our en-US translations file to make sure that your keys are correct.\n\n\nTo support multiple locales, you must add the translation data for each locale within the adyenTranslations.js file.\nBelow is an example of how your translations file could look like:\n\n \nStep 13: Configure performance analytics\n\n \n Optional\n \n\n\nWe use anonymized usage data to monitor system performance and ensure cartridge stability. This does not impact checkout performance, and no personal or payment data is included in these analytics.\nTo enable analytics, do the following.\n\nIn your Salesforce Business Manager, go to Adyen Settings > Local Payment Method settings > Adyen Plugin Performance Monitoring.\nSelect Enable, and save your settings.\n\nThis feature collects anonymized information about the cartridge health and reports unexpected failures to Adyen. When enabled, a scheduled job with ID ProcessAnalytics is added to the Salesforce Business Manager. Configure this scheduled job.\nDisabling analytics does not impact your access to core features, but it can limit our ability to detect issues or provide tailored support.Step 14: Accept Customer Service Center orders\nUse Adyen payment links to process orders in the Salesforce Customer Service Center (CSC). This allows your customer service agents to create orders on behalf of shoppers and provide a secure link for payment.\nCustomer Service Center orders are enabled by default, to place an order:\n\nIn your Salesforce Business Manager, go to Merchant Tools > Ordering > Customer Service Center.\nComplete all required order details for the shopper, select the option to authorize the full order amount and submit the order.\nIn the pending payment pop-up that appears, locate the generated payment link and share it with your shopper.\n\nThe pending payment error message indicates that a pending payment needs to be fulfilled before the order can be processed. You can close the error dialogue after you have shared the link with the shopper.\n\n\nAfter your shopper completes the payment, the order will be processed. To check the status of a payment, you can view the payment link in your Customer Area. You can also find the payment link in the Order Notes section in the Salesforce Business Manager.","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"Salesforce Commerce Cloud - B2C Commerce","lvl3":"Storefront Reference Architecture (SFRA)","lvl4":"Set up the cartridge"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/plugins","lvl2":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud","lvl3":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra","lvl4":"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge"},"levels":5,"category":"Plugins","category_color":"green","tags":["cartridge"]},{"url":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge?plugin=Salesforce SFRA&integration=cartridge","title":"Salesforce SFRA cartridge","content":"Requirements\nBefore you begin, make sure that you have performed the following steps:\n\nCreate a test account with Adyen. With this, you will 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.\nFinish the metadata import.\n\nIn Salesforce Commerce Cloud, enforce HTTPS.\n\nTo be compatible with the Chrome v80 Cookie policy, you need to enforce the use of HTTPS for all sites.\n\u00a0\n\n\nAccount structure\nWith Adyen, you have a single company account, and one or more sub-accounts called merchant accounts. However, in Salesforce, you can only have one merchant account for each storefront.Step 1: Set up the cartridge path\nTo set up the cartridge path in the Business Manager:\u00a0\n\n\nGo to\u00a0Administration\u00a0>\u00a0Sites\u00a0>\u00a0Manage Sites\u00a0>\u00a0[yourSite]\u00a0>\u00a0Settings.\u00a0\n\n\nIn the\u00a0Cartridges\u00a0box, enter:\napp_adyen_SFRA:int_adyen_SFRA:int_adyen_webhooks:app_storefront_base\nIf you are using any form of customizations, make sure to follow our customization guide on best practices around customizations.\n\n\nSelect Apply.\n\nStep 2: Enable the Salesforce Business Manager configuration page\nTo show the Adyen Settings menu item in your Salesforce Business Manager:\n\nGo to Administration > Sites > Manage Sites > Business Manager - Settings.\nIn the Cartridges box, enter bm_adyen:int_adyen_SFRA:app_storefront_base. Select Apply.\nGo to Administration > Organization > Roles & Permissions > Administrator - Business Manager Modules.\nIn the dialogue box, select the site you want to enable Adyen for or select the Sites box to select all. Select Apply.\nUnder Site Preferences, find Adyen Settings in the list and select the checkbox in the right column. At the bottom of the page, select Update.\nStep 3: Generate an API key and client key\nTo connect your Commerce Cloud store to the Adyen API, you need to generate an API key in your Customer Area and add it to your Salesforce Business Manager.\nTo authenticate requests from your payment environment, the cartridge also needs a client key. You need to generate a client key in your Customer Area and add it your Salesforce Business Manager.\nGenerate an API key in your Customer Area\n\nLog in to your Customer Area and select your Company account.\nGo to Developers > API credentials.\nSelect the Payments or Platforms tab, depending on your integration type.\nSelect the credential username.\nUnder Server settings > 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\nGenerate a client key in your Customer Area\n\nLog in to your Customer Area.\nGo to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].\nUnder Client settings > 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\nAfter generating both keys, add them to your Salesforce Business Manager:\n\nIn your Salesforce Business Manager, go to Merchant Tools > Site Preferences > Adyen settings > Account settings.\nUnder Adyen Client Key, enter the client key that you generated.\nUnder API key of webservice, enter the API key that you generated.\nSelect Save Changes.\nStep 4: Set up account settings\n\n\nIn your Salesforce Business Manager, go to Merchant Tools > Site Preferences > Adyen settings > Account settings, and fill the following fields:\n\n\n\nField\nDescription\n\n\n\n\nEnvironment\nSelect Test for setting up and testing your integration. When going live, you need to change this setting to Live.\n\n\nAdyen Client Key\nThe client key that you generated.\n\n\nStorefront Reference Architecture (SFRA) - version 6 or 7\nOnly if you are using SFRA version 6 or 7, select Enable.\n\n\nMerchant Account\nThe name of your Adyen merchant account.\n\n\nAPI key of webservice\nThe API key that you generated.\n\n\n\nThe Adyen Live Prefix and Front-end resources region fields are only relevant after you have set up and tested your integration, and are ready to go live. Find the information for these fields in our go-live checklist.\n\n\nSelect Save Changes.\n\nStep 5: Set up webhooks\nTo inform your Commerce Cloud store of payment status changes, Adyen uses webhooks, sent as HTTP callbacks to endpoints on your server. To receive webhooks, you need to enter your server's details in the Customer Area, and add the webhooks credentials to the Salesforce Business Manager.\n1. Set up webhooks in the Customer Area\n\n\nIn your Customer Area, go to Developers\u00a0>\u00a0 Webhooks.\n\nWe recommend to configure webhooks for your company account. This ensures that you do not have duplicate webhook configurations, and improves performance.\n\n\n\nSelect Webhook.\n\n\nFrom the list of webhooks, next to Standard webhook, select Add.\n\n\nUnder General, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nEnabled\nSelect the toggle to enable or disable the webhook.\n\n\nVersion\nThe webhook version.\n\n\nDescription\nYour description of the webhook.\n\n\nMerchant accounts\nYou can apply the webhook to all merchant accounts for a company account, include only specific merchant accounts, or exclude specific merchant accounts for your company account.\n\n\n\n\n\nUnder Server configuration, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nURL\n- URL: Your webhook server's URL, adding \/Adyen-Notify at the end, for example: https:\/\/zzft-xx.sandbox.XXXX.dx.commercecloud.salesforce.com\/on\/demandware.store\/Sites-RefArch-Site\/default\/Adyen-Notify.\n\n\nMethod\nHTTP POST\n\n\nEncryption protocol\nTLSv.1.3\n\n\n\nUnder Security, configure the following:\n\n\n\nSetting\nDescription\n\n\n\n\nBasic authentication\nEnter your server's username and password. You need to enter these credentials in the Salesforce Business Manager later.\n\n\nHMAC Key\nGenerate the HMAC Key, copy it, and store it securely in your system. You need to enter the HMAC key in the Salesforce Business Manager later. We strongly recommend that you use HMAC signatures to protect your server from unauthorised webhook events.\n\n\n\n\n\nUnder Events settings, select the event codes for this webhook. Some webhook types do not support more than one event code, so this setting does not appear.\n\n\nIf the Additional settings section is available, optionally select the additional information you want to receive in this webhook. Some webhook types do not support more than one event code, so this section does not appear.\n\n\nSelect Save configuration.\n\n\n2. Add webhook credentials to the Salesforce Business Manager\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Webhook settings.\nEnter the Webhook username and Webhook password from your Customer Area.\nOptionally, enter your HMAC Key.\nSelect Save changes.\n\n3. Test webhooks\nTo test your webhooks:\nYour server must acknowledge webhooks with a successful HTTP response status code (like 202).\n\nLog in to your Customer Area.\nSelect Developers > 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.\n4. Configure scheduled jobs\nWebhooks are stored in Commerce Cloud as custom object instances to be processed by scheduled jobs.\nAfter the metadata import, a scheduled job with ID\u00a0Process is added to the Salesforce Business Manager: \u00a0Administration\u00a0>\u00a0Operations\u00a0>\u00a0Jobs. This scheduled job has two steps (you can check this in the Job Steps tab):\u00a0\n\nProcess \u2013\u00a0Processes the webhook and updates the payment status of the order.\nClean \u2013\u00a0 Deletes the custom object instance, once it has been processed.\n\nTo optimize the processing of your instances, we recommend that you set the frequency of this scheduled job to 1 minute:\u00a0\n\nGo to the Schedule and History tab for the Process scheduled job.\nSet Trigger to Recurring Interval.\nIn the Run Time pane, set Amount to 1, and Interval to Minutes.\u00a0\nStep 6: Store shopper details\n\n \n Optional\n \n\n\nWith Adyen tokenization,\u00a0you can\u00a0securely store\u00a0payment details of your shoppers. This allows you to offer a faster checkout experience by using their stored card.\nTo set this up:\n\nIn the Salesforce Business Manager, go to\u00a0Merchant tools\u00a0>\u00a0Site Preferences\u00a0>\u00a0Adyen Settings.\nIn the Additional settings section, under Tokenisation, select Enable.\nIn the Local payment method settings section, under Store shopper details: one-click, select Enabled to securely store the payment details of your shoppers for later payments, where the shopper needs to enter their CVC\/CVV to complete the payment.\nSelect Save Changes.\nTo store payment details of guest users, go to Site Preferences > Order > Generate Customer No. for Guest Orders, and select Yes.\nSelect Apply.\n\nPayment details are stored in shopper accounts in the Salesforce platform. To be able to delete saved payment details from a shopper's account, you have to configure an additional setting. To set this up, contact our Support Team.Step 7: Set up in-person payments\n\n \n Optional\n \n\n\nYou can set up endless aisle for your physical stores to let your shoppers place ecommerce orders in your stores using payment terminals. We recommend to:\n\nCreate a separate merchant account for ecommerce and in-person payments channels that contains the stores where you will offer endless aisle. See set up your account for in-person payments to learn more about account structures.\nCreate a new SFCC site, and link it to the merchant account you created to process endless aisle payments. You can link only one SFCC site to for each merchant account.\nAdd authentication credentials for the SFCC site you created for endless aisle payments. This lets you track the store employees that are using the feature.\n\nTo process payments in your Commerce Cloud stores using payment terminals:\n\nEnable in-person payments in your Salesforce Business Manager.\nConfigure services in your Salesforce Business Manager.\nCreate a Store ID in your Adyen Customer Area.\nEnable Terminal API for the store you created in your Salesforce Business Manager.\n\nEnable in-person payments\n\nIn the Salesforce Business Manager, go to\u00a0Merchant Tools\u00a0>\u00a0Ordering\u00a0>\u00a0Payment methods.\nSelect\u00a0AdyenPOS.\nSelect\u00a0Yes\u00a0in the\u00a0Enabled\u00a0column.\nFrom\u00a0the\u00a0Payment Processor\u00a0drop-down\u00a0in the\u00a0AdyenPOS Details\u00a0section, select\u00a0Adyen_POS.\n\nConfigure services\n\nIn the Salesforce Business Manager, go to\u00a0Administration\u00a0>\u00a0Operations\u00a0>\u00a0Services.\nUnder Services, select AdyenPosPayment.\nIn the\u00a0Name\u00a0box,\u00a0enter\u00a0AdyenPosPayment.\nIn the Profile dropdown, select AdyenPOS.\nUnder Profiles, select AdyenPOS.\nIn the\u00a0Connection Timeout (ms)\u00a0box, enter\u00a0100.000.\nMake sure that the\u00a0Enable Circuit Breaker\u00a0checkbox is not selected.\n\nCreate Store ID\nIn your Adyen Customer Area, create a Store ID.\nYou can create multiple store IDs if you are going to offer endless aisle in more than one store.\nEnable Terminal API for your stores\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > In-person payments settings.\nSelect StoreID for Terminal API, and select the ID for the store you created.\n\nIf you add new stores in your Customer Area later, you must follow the steps again to enable in-person payments for the new stores you created.Step 8: Set up donations with Adyen Giving\n\n \n Optional\n \n\n\nAdyen Giving is enabled by default in your Salesforce Business Manager settings.\nIf a donation campaign is set up and active in your test Customer Area merchant account, shoppers can donate when they use a payment method that supports donations.\nTest and go live with Giving\nTest your integration by doing the following:\n\nCreate and activate a test donation campaign.\nUse our test cards to make a donation.\nGet the DONATION webhook for the donation.\n\nWhen you are ready to go live with Giving, enable the Adyen Giving merchant webhook, and create and activate a live donation campaign in your live Customer Area.\nWhen you make live donations, you can verify the outcome by either:\n\nFinding the donation in a Giving report or dashboard.\nGetting the DONATION webhook for the donation.\nStep 9: Use risk management features\n\n \n Optional\n \n\n\nOur cartridge gives you access to various risk management features that Adyen offers, to let you detect, handle, mitigate, analyze and monitor fraud.\nBasket fields\nYou can create custom risk rules to influence the risk score of a transaction. Custom risk rules are a RevenueProtect premium feature.\nYou can use Basket fields for custom risk rules. To include the Basket fields in your payment request:\n\nIn the Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Additional Settings.\nUnder Basket fields, select Enable.\nSelect Save Changes.\n\nCase management\nFor an extra layer of fraud protection, you may want to manually review a transaction before it is captured. A transaction can be sent to case management for manual review when it reaches a certain risk score, or triggers a specific risk rule.\nYou have to enable RevenueProtect premium, and configure manual review settings to use case management.\nSet up case management in the Adyen Customer Area:\n\nLog in to your Adyen Customer Area with your company account.\nAssign roles to users for manual review.\nSet a trigger for manual review.\nConfigure actions and webhooks.\nThese are the recommended Case management behavior settings for the cartridge:\nAccept: Select None and then select Send notification.\nReject: Select Cancel and then select Send notification.\nExpire: Select Cancel, and then select Reject under Notification.\nSelect Save configuration.\n\nData collection\nThe cartridge collects risk data on the checkout page and sends it to Adyen by default.\nIn addition to the data that you send when the shopper checks out, you can also optionally collect data to on any of your Salesforce ISML templates that generate your storefront pages to detect fraud outside of your checkout page.\nRefer to Collect additional data outside of the checkout page to set up data collection on any of your web pages.Step 10: Send Level 2\/3 data for cards\n\n \n Optional\n \n\n\nSending Level 2 or Level 3 Enhanced Scheme Data allows you to cut your interchange rates on US domestic transactions by up to 90 basis points. At the same time, your shoppers will see additional information about their purchase on their credit card statement.\nNot all businesses can submit Level 2\/3 data. Refer to What is Enhanced Scheme Data? for more information.\n\nSending Level 2\/3 data is supported from v20.1.3 of the cartridge.\n\nTo send Level 2\/3 data:\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Additional settings.\nUnder Level 2\/3 Data, select Enabled.\nUnder Commodity code, enter the UNSPSC commodity code for your products or services.\nSelect Save Changes.\nStep 11: Add system integrator info\n\n \n Optional\n \n\n\nIf your integration with Adyen is built by a system integrator let us know their name, so that we can offer you better support.\n\nAdding system integrator info is supported from v20.1.3 of the cartridge.\n\n\nIn the Salesforce Business Manager, go to Merchant tools > Site Preferences > Adyen Settings > Additional Settings.\nUnder System integrator, enter the name of your system integrator.\nStep 12: Configure localization\n\n \n Optional\n \n\n\nLocalization is supported in the SFCC cartridge. You can add translations for multiple locales by doing the following.\n\nOpen the translation file: int_adyen_SFRA\/config\/adyenTranslations.js.\nFor each key-value pair, add your translation. Your checkout form uses the translations for each corresponding locale.\n\nYou must not change the keys.\nRefer to our en-US translations file to make sure that your keys are correct.\n\n\nTo support multiple locales, you must add the translation data for each locale within the adyenTranslations.js file.\nBelow is an example of how your translations file could look like:\n\n \nStep 13: Configure performance analytics\n\n \n Optional\n \n\n\nWe use anonymized usage data to monitor system performance and ensure cartridge stability. This does not impact checkout performance, and no personal or payment data is included in these analytics.\nTo enable analytics, do the following.\n\nIn your Salesforce Business Manager, go to Adyen Settings > Local Payment Method settings > Adyen Plugin Performance Monitoring.\nSelect Enable, and save your settings.\n\nThis feature collects anonymized information about the cartridge health and reports unexpected failures to Adyen. When enabled, a scheduled job with ID ProcessAnalytics is added to the Salesforce Business Manager. Configure this scheduled job.\nDisabling analytics does not impact your access to core features, but it can limit our ability to detect issues or provide tailored support.Step 14: Accept Customer Service Center orders\nUse Adyen payment links to process orders in the Salesforce Customer Service Center (CSC). This allows your customer service agents to create orders on behalf of shoppers and provide a secure link for payment.\nCustomer Service Center orders are enabled by default, to place an order:\n\nIn your Salesforce Business Manager, go to Merchant Tools > Ordering > Customer Service Center.\nComplete all required order details for the shopper, select the option to authorize the full order amount and submit the order.\nIn the pending payment pop-up that appears, locate the generated payment link and share it with your shopper.\n\nThe pending payment error message indicates that a pending payment needs to be fulfilled before the order can be processed. You can close the error dialogue after you have shared the link with the shopper.\n\n\nAfter your shopper completes the payment, the order will be processed. To check the status of a payment, you can view the payment link in your Customer Area. You can also find the payment link in the Order Notes section in the Salesforce Business Manager.","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"Salesforce Commerce Cloud - B2C Commerce","lvl3":"Storefront Reference Architecture (SFRA)","lvl4":"Set up the cartridge"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/plugins","lvl2":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud","lvl3":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra","lvl4":"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge"},"levels":5,"category":"Plugins","category_color":"green","tags":["Salesforce SFRA","cartridge"]}]}