API Reference

Our reference library for integrating with our API


Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

Salesforce Commerce Cloud

Get started with our Salesforce Commerce Cloud (SFCC) integration, from installing the LINK cartridges to making your first test payment.

You can use our LINK cartridges with Storefront Reference Architecture (SFRA) or controller-based SiteGenesis.

Before you start

Create a test account

If you haven't already, create a test account.

Get your API keys

To set up our SFCC integration, you'll need three API keys: a secret one, a public one, and a private shared one. The first two are generated automatically upon account creation. The last one is generated when you create a webhook for your business.

Webhooks are notifications that we send when an event occurs on your account. For example, when a payment is captured. These are used by the SFCC plugin to update the status of an order. Read more about webhooks.

  1. Log in to your test account on the Hub sandbox.
  2. In the left menu, go to Settings > Channels, and make a note of your secret and public API keys.
  3. Scroll down to the Webhooks section of the page and click New webhook.
  4. Enter the following URL, replacing with the URL of your shop: 

    Correctly configuring your webhooks is important; if they're incorrectly formatted, the plugin will not work.

  5. Select API - v2.0.
  6. Tick Select all, then click Create webhook.

  7. Click on the webhook you just created, and make a note of the private shared API key.

Install the LINK cartridges

Upload the cartridges

  1. Download our installation package from GitHub. This package includes the frontend cartridges for SFRA (int_checkoutcom_sfra) and SiteGenesis (int_checkoutcom), as well as the backend cartridge (bm_checkoutcom), which is compatible with both SFRA and SiteGenesis.
  2. Upload the relevant cartridges to your server, using a tool like UX Studio:
    • If you're using SFRA, install int_checkoutcom_sfra and bm_checkoutcom.
    • If you're using SiteGenesis, install int_checkoutcom and bm_checkoutcom.
  3. Log in to your Business Manager account, and go to Administration > Sites > Manage Sites > [your site] > Settings.
  4. In the Cartridges field, add one of the following to the front of the cartridge path and click Apply:
    • For SFRA, add int_checkoutcom_sfra:bm_checkoutcom:.
    • For SiteGenesis, add int_checkoutcom:bm_checkoutcom:.

SFRA example:

Import the metadata

  1. In a file browser, open the metadata folder in the installation package you downloaded earlier, then go into the sites subfolder.
  2. Rename the default named folder to the name of the site for which you want to import the cartridge:
    • For SFRA, rename the RefArchGlobal folder to the name of your site.
    • For SiteGenesis, rename the SiteGenesisGlobal folder to the name of your site.
  3. Navigate back to the package's root folder, and zip the metadata folder.
  4. Next, log in to Business Manager and go to Administration > Site Development > Site Import & Export.
  5. Under Upload Archive, select Local and then click Choose file.
  6. Find the you just created, click Open and then Upload.

Edit the template file (SiteGenesis only)

If you use SiteGenesis, you also need to edit the payment methods template in order to show the payment option on the billing page.

To do so, add the following code snippet to the /app_storefront_core/cartridge/templates/default/checkout/billing/paymentmethods.isml file:

<iscomment> - Integration example
  Add this code to your paymentmethods.isml file
<isif condition="${(dw.system.Site.getCurrent().getCustomPreferenceValue("ckoEnabled"))}">  
    <isinclude template="ckoPayments" />
    Site Genesis - Default Credit card block
    Add the default SiteGenesis credit card form code here.

If your site is also using the default SiteGenesis credit card form, place the code of the form (found in the core paymentmethods.isml template file) after the <iselse> block in the snippet shown above.

This will display the credit card form if enabled in the custom preferences, and display the default Site Genesis credit card form if not.

The credit card form is not compatible with the default SiteGenesis credit card form. Please disable the default credit card form if using the credit card form, and vice versa.

Configure the cartridges

  1. Log in to Business Manager, and go to Merchant Tools > Site Preferences > Custom Preferences > Sandbox API.
  2. Enter the public key, secret key, and private shared key from your sandbox Hub account, and click Save.
  3. Go back to the custom site preferences page and click Global Settings.

  4. Make sure Enable is set to Yes, to enable the card payment form.
  5. Set Mode to Sandbox, so you can start testing card payments.
  6. Enter your Business Name (the name of your shop), and fill in the business address, city and country fields.
  7. Choose whether or not you want to Auto capture your payment. Set to Yes if you want your payment to be captured (i.e., the money due from the customer's account is moved into your account) immediately after being authorized. Set to No if you want to capture the payment manually.
  8. If you set Auto capture to Yes, you can specify the delay (in hours) before the payment is captured. For example, entering 1.5 would capture the payment one hour and 30 minutes after authorization. The default is 0.
  9. Click Save.

That's it! You're ready to start testing card payments.

Test your integration 

  1. Go to your storefront and add a product to your cart.
  2. Go to your cart and proceed to the checkout.
  3. Enter the required billing details. You can put anything here, though we recommend using a real email address so you can receive the order confirmation.
  4. Select the Pay by Card with method.
  5. Enter test card details (you can use any future expiry date).
  6. Click Place order, and you will be redirected to the order confirmation page. If you entered a real email address in the billing details, you'll also receive an order confirmation email.
  7. Log in to Business Manager.
  8. Go to Merchant Tools > Ordering > Orders and click Find to show your orders. Your test order will be displayed there with a Created status. This indicates that the payment has been successfully authorized and captured. The transaction will also appear in the Payments section of your sandbox Hub account.

You can now either go live as-is or extend your configuration.


If this test does not work, first check you have configured your webhooks correctly. For the plugin to work, they must be formatted correctly. If you have configured them properly, check your server; if it's password-protected or it restricts unfamiliar IP addresses, it may be blocking webhook notifications. Contact our Integration team at if you need help.

Further testing

You'll find more test cards and a range of scenarios to trigger in our testing guide.

Go live 

If you're happy with the outcome of your testing and want to start taking payments right away, please contact our Sales team in order to move to a live account.

Before you go live, remember to:

  • Switch the cartridge Mode from Sandbox to Live in Business Manager.
  • Enter your live public, secret and private shared API keys in the Live API section of Custom Site Preferences.
  • Configure the webhook URLs in your live Hub account.

Extend your configuration

You can extend your integration to add more payment methods, use 3D Secure payments, and more.