Vue Storefront is now Alokai! Learn More
Salesforce Commerce Cloud setup

Salesforce Commerce Cloud setup

Adyen provides an offiial cartridge for SFCC. It enables SFCC to use the Adyen payment service. This guide will show you how to install the cartridge in your SFCC environment before you start working with our integration.


There are several ways to upload cartridges to an SFCC environment. In this guide, we are going to use Prophet Debugger extension for Visual Studio Code. If you are using Eclipse, read the unofficial guide created by Bee It. There is also an offical SFCC documentation mentioning possible options.




Get a local copy of the Adyen cartridge

Clone the repository containing the cartridge from Github onto your local machine:

git clone

Our Integration mostly relies on the Job and the provided metadata. Everything else can be deleted.


Create a dw.json file

In the root of the repository, create a new file named dw.json with the following content:

    "hostname": "<environmentId>",
    "username": "<username>",
    "password": "<password>",
    "version": "<version>",
    "cartridge": []

Remember to replace the following with your credentials:

  • <environmentId> - the ID of your SFCC environment, consisting of the realm and the instance ID, separated with a hyphen (-),
  • <username> - a valid name of a user that has access to your SFCC environment,
  • <password> - a valid password of a user that has access to your SFCC environment,
  • <version> - the active version of your SFCC code (e.g. "SFRA_AP_01_24_2024"). You can check it in your SFCC Business Manager console in the Administration > Site Development > Code Deployment section.


Install the Prophet Debugger extension

In Visual Studio Code, press Command + Shift + P and search for Extensions: Install Extensions. Find and install the Prophet Debugger extension.


Upload cartridges to your SFCC environment

In Visual Studio Code, press Command + Shift + P and search for View: Show Prophet to open the Prophet Debugger view. Your sidebar should now display a list of cartridges available in the repository (e.g. bm_adyen, int_adyen_overlay, int_adyen_SFRA). In the top-right corner of the window containing the list, find a red, circular arrow button. Click it to upload all cartridges at once.

When the Your sandbox has extra cartridges prompt appears, dismiss it by clicking the Leave all always button.


Import Adyen cartridge Metadata in the Business Manager

Follow this documentation from Adyen to learn about importing the metadata. Since you've already cloned the cartridge repository and - most likely - don't need to customize its code now, you can start from step 5 (i.e. zipping the package/metadata/site_import folder).


Set up the cartridge in the Business Manager

Follow this documentation from Adyen to learn about setting up the cartridge in the Adyen Customer Area as well as the Business Manager. Keep in mind there are two versions of this guide: for cartridge version 22.2.0 or earlier and for version 22.2.2 or later.

After following this documentation, you should have:

  • set up cartridge paths in your Site settings and (optionally) in your Business Manager settings,
  • added Adyen API Key and Client Key to your Adyen Account Settings in Merchant Tools > Site Preferences > Custom Preferences > Adyen Account Settings,
  • set up a webhook in Adyen,
  • configured scheduled jobs responsible for adding custom Adyen objects to SFCC orders (keep in mind if you're using a TEST SFCC environment, job scheduling is unavaliable and you will have to run it manually for every order instead),


(Optional) Set up an additional Pipeline URL for Adyen webhook

If rule-based Storefront URLs are enabled in your SFCC environment, you will need to create an additional Pipeline URL for your Adyen webhook.

Go to Merchant Tools > SEO > URL Rules > Pipeline URLs and add a new record in the Pipeline Aliases table and confirm by clicking the Apply button.

PipelineAlias (resolves to)

What next?

With the Adyen cartridge installed and configured in your Salesforce Commerce Cloud environment, proceed to the Alokai Storefront setup guide.