Saleforce - Commerce Cloud Integration Guide

SeerBit payment gateway integration in Salesforce-Commerce Cloud

The SeerBit payments cartridge offers a convenient payment solution, granting you access to SeerBit's payment gateway features with minimal integration effort, allowing you to begin accepting payments swiftly. You can seamlessly integrate SeerBit as the payment processor for your Salesforce Commerce Cloud (SFCC) e-commerce site, leveraging the Storefront Reference Architecture (SFRA) framework.

This document outlines the step-by-step process to integrate the SeerBit payment processor into your SFCC site: 

Access to SeerBit Cartridge

Seerbit cartridge can be downloaded from this repository Seerbit Cartridge

  1. Request for access to the repository by clicking on Seerbit Cartridge
  2. In the repository you will find the following folders:
    1. Metadata
    2. App_custom_seerbit
  3. Clone the repository using the command:
    1. Git clone
    2. Open the package/metadata/seerbit_cartridge /sites/ folder in the Seerbit repository.
    3. Rename the yourSiteId folder to the ID of your site in your Salesforce Business Manager.
    4. Zip the seerbit_cartridge folder.

Business Manager Setup

Site 1: Site Import (If required)

  1. To import the Storefront Reference Architecture Demo Sites into your Salesforce Sandbox, follow these steps:
    1. Log in to your Business Manager.
    2. Navigate to Administration → Site Development → Site Import & Export.
    3. Click on "Select Storefront Reference Architecture Demo Sites".
    4. On the page that appears, choose the storefront reference architecture site that you want to import. If you have your own site, you can select that as well.
    5. Click on "Deploy".
    6. Wait for some time as the import process may take a while, depending on the size of the site and your system's processing speed.
    7. Once the import process is complete, you will be able to see the reference sites in your Business Manager.

This process allows you to import demo sites or your own site into your Salesforce Sandbox for testing and development purposes.

Site 2: Import the MetaData

  1. Open the package/metadata/seerbit_cartridge folder.
  2. Zip the seerbit_cartridge folder.
  3. Select your site in your business manager.
  4. In the Business Manager, navigate to Administration > Site Development > Site Import & Export, and proceed to import the seerbit_cartridge zip file.
  5. After the upload process is finished, choose the recently uploaded zipped folder and then click on the Import button
  6. Following the import, attributes labelled Seerbit[attributeName] are included in the following section:
    1. Navigate to Merchant Tools → Ordering → Payment Processors. Here, you will find SEERBIT_PROCESSOR
    2. In the Merchant Tools → Ordering → Payment Methods section, you will find SeerBit. Please verify whether the SeerBit payment method is enabled. If it is not enabled, ensure to set its status to "Yes" to activate it. 
    3. Additionally, the following services are introduced: and app.seerbit.token. You can locate these services under Administration → Operations → Services.

Site 3: Adding API Keys & URL in Business Manager

  1. Obtain Seerbit Public API Key and Seerbit Secret API Key from the Seerbit Dashboard (SeerBit - Merchant Dashboard).
  2. Navigate to Business Manager → Merchant Tools → Site Preferences → Custom Preferences → SEERBIT_PAY. 
  3. Select SEERBIT_PAY and add the following keys: seerbit_private_key, seerbit_public_key, and seerbit_url. Save the changes.
    1. Set the Seerbit_url as following:
    2. URL: your-commercecloud-instance-url, adding /Order-SeerbitConfirm at the end, for example:

Site 4: Setting up the Cartridge Path

  1. In Business Manager, go to Administration Sites Manage Sites. A new site should be visible.
  2. Click on the RefArch site, then select the "Settings" tab. Add the following cartridges under Cartridges:
  3. Select Apply to save the changes.

Cartridge code setup in Visual Studio Code 

  1. Clone the Seerbit Cartridge repository from the following URL: into your preferred Integrated Development Environment (IDE), for example, Visual Studio Code.
  2. Inside the root folder of the repository, locate a file named dw.json. Within dw.json, provide the hostname, username, password, and code-version. Below is a sample content structure of dw.json:

    "hostname": "your-commercecloud-instance-url",

    "username": "your-username",

    "password": "your-password",

    "code-version": "your-code-version"

  3. Replace "your-commercecloud-instance-url", "your-username", "your-password", and "your-code-version" with your specific credentials and code version.
  4. To create the code version in the Business Manager, follow these steps:
    1. Navigate to Business Manager → Administration → Site Development → Code Deployment.
    2. On this page, click on the "Add" button displayed under code versions.
    3. Provide the same code version name as mentioned in the dw.json file.
    4. Click on "Apply" to save the changes.
    5. After creating the code version, select the newly created version from the list and click on the "Activate" button located in the "Actions" column corresponding to that row. This will activate the code version for use in your Salesforce Commerce Cloud instance.
  5. To create a launch.json file inside the root folder of storefront-reference-architecture-master and app_custom_seerbit cartridges, follow these steps:
    1. Open your preferred text editor or IDE.
    2. Navigate to the root folder of the storefront-reference-architecture-master and app_custom_seerbit cartridges.
    3. You need to add storefront-reference-architecture-master cartridge inside your folder. After adding inside your folder you can see two cartridges. Storefront-reference-architecture-master and app_custom_seerbit cartridges.
    4. Create a new file named launch.json inside the two cartridges.
    5. Below is a sample launch.json file:

      "version": "0.2.0",

      "configurations": [


      "type": "prophet",

      "request": "launch",

      "name": "Attach to Sandbox",

      "hostname": "****-***",

      "username": "",

      "password": "*******",

      "code-version": "example_10",

      "workspaceroot": "${workspaceFolder}"


      In the launch.json file, provide the hostname, username, password, and code-version based on your environment. Replace "-.dx.commercecloud." with your Commerce Cloud instance's hostname, "" with your username, "****" with your password, and "example_10" with your desired code version.

Code Implication and Installation Process

Step 1: Install Node Modules

From the root directory of your cartridge, use the command line to install Node modules by executing the following command: npm install

This command will automatically install all the necessary Node modules and dependencies specified in the package.json file within your cartridge's directory.

Step 2: Build Code

npm install sgmf-scripts

node node_modules/sgmf-scripts --help

npm run compile:js

Step 3: Upload the code to Business Manager

To upload the cartridges into your Business Manager, follow these steps:

  1. Ensure you have the ProphetDebugger extension installed in Visual Studio Code (VSCode). If it's not available, you can download it from the VSCode Extension Marketplace.
  2. Open Visual Studio Code.
  3. Navigate to the ProphetDebugger extension within VSCode.
  4. Use the extension to upload the cartridges into your Business Manager. The ProphetDebugger extension typically provides functionalities to facilitate this process directly from within VSCode.
  5. Follow the prompts and instructions provided by the extension to complete the upload process. This may involve connecting to your Salesforce Commerce Cloud instance and selecting the cartridges you want to upload.

By using the ProphetDebugger extension in VSCode, you can efficiently upload the cartridges to your Business Manager without leaving your development environment.

Verification Process

Note: If products are available on the site but are not displaying in the storefront, follow these steps:

  1. Go to Business Manager → Merchant Tools → Search → Search Indexes.
  2. Click on the checkboxes for all IndexTypes to select them.
  3. After selecting all IndexTypes, click on the "Rebuild" button.
  4. This action will trigger a rebuild process for all product indexes, ensuring that all products are properly indexed and displayed online on the storefront.
  5. The below picture is the reference for the storefront with all the products.
  6. Add products into the Cart, then click on the cart and now we can see the checkout like the below.
  7. Then click on checkout to provide the required details like mailId, address fields etc, click on makePayments button. Now you can see the two payment options one is Credit Card and the other SeerBit. 
  8. To make payment using Seerbit payments, click on the Seerbit Payments radio button.
  9. You will be redirected to the Seerbit Payments page.
  10. In that page, you will be prompted to choose your payment method and click on the pay button.
  11. After completing the payment it will be redirected to the storefront page here we can see the Thank you page.

  12. In Business manager we can the Order Details.
  13. In order we can see the Payment details as well.


We trust this comprehensive guide has furnished you with clear instructions for integrating the Seerbit payment gateway into your Salesforce Commerce Cloud (SFCC) ecommerce site. By adhering to these steps diligently, you can seamlessly enable Seerbit as your payment processor and promptly begin accepting payments. If you encounter any challenges during the integration process, please feel free to reach out to our support team for assistance. Wishing you success and happy selling with Seerbit!