---
title: "Install and set up the Salesforce OMS package"
description: "Learn how to install and set up your Adyen Salesforce OMS package."
url: "https://docs.adyen.com/plugins/salesforce-order-management-system/install-and-set-up-the-package"
source_url: "https://docs.adyen.com/plugins/salesforce-order-management-system/install-and-set-up-the-package.md"
canonical: "https://docs.adyen.com/plugins/salesforce-order-management-system/install-and-set-up-the-package"
last_modified: "2023-12-12T16:56:00+01:00"
language: "en"
---

# Install and set up the Salesforce OMS package

Learn how to install and set up your Adyen Salesforce OMS package.

[View source](/plugins/salesforce-order-management-system/install-and-set-up-the-package.md)

This page explains how to integrate with our OMS package to manage orders for your Salesforce Commerce Cloud store that uses the Adyen payments cartridge.

## Salesforce OMS package

Set up the Adyen Salesforce OMS package

### Before You Begin

## Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

| Requirement                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ----------------------------------------------- |   |
| **Integration type**                            | Make sure that you have a Salesforce Commerce Cloud (SFCC) storefront that uses the [Adyen payments cartridge](/plugins/salesforce-commerce-cloud).                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **[Webhooks](/development-resources/webhooks)** | Subscribe to the Standard webhooks.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Setup steps**                                 | Before you begin:- Create a Salesforce OMS Org.
- Connect your SFCC storefront and OMS Org. Refer to [the documentation from Salesforce](https://resources.docs.salesforce.com/latest/latest/en-us/sfdc/pdf/sfom_impl_b2ce.pdf) to read more about connecting B2C Commerce and Order Management.
- [Enable manual capture](/online-payments/capture/#enable-manual-capture) in your Customer Area.
- Install the base dependent [`API Library Apex Adyen` package](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N3u00000PraxuEAB) with the installation key **Payments\@Adyen**. |

## How it works

With our Salesforce OMS package, you handle captures and refunds for the payments of your [Salesforce Commerce Cloud storefront](/plugins/salesforce-commerce-cloud). The package keeps the Adyen and Salesforce systems in sync, so that you can seamlessly manage your order and payment flows.

To set up the package:

1. Follow the [guided configuration](#guided-configuration) flow. Optionally, you can still [set up the package manually](/plugins/salesforce-order-management-system/install-and-set-up-the-package/manual-setup).
2. After you have set up the package, [configure capture settings](#configure-capture-settings) to make sure your [order status lifecycle](/plugins/salesforce-order-management-system/order-status-lifecycle) runs as expected.
3. When you are ready to go-live, follow the [steps to go-live](#go-live).

## Install the app

1. In your Salesforce OMS Org, [enable multiple currencies](https://help.salesforce.com/s/articleView?id=sf.comm_currency_considerations.htm\&type=5).
2. Install the [Adyen Payments for Salesforce Order Management (SOM) app](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N3u00000ON7RtEAL\&tab=d) with the installation key **Payments\@Adyen**.
3. Follow the instructions on the [Salesforce Application Installation Guide](https://developer.salesforce.com/docs/atlas.en-us.appExchangeInstallGuide.meta/appExchangeInstallGuide/appexchange_install_installation.htm).

### Guided Configuration

## Follow the guided configuration

From v3.3.0 onwards, the Salesforce OMS package includes a guided configuration.

1. Open your Salesforce OMS.
2. Go to **App Launcher** > **Adyen Config Page**.
3. Follow the on-screen steps to complete the setup.

### Configure Sfcc

## Configure capture settings

With our OMS package, you can capture payments at any step in your order fulfillment flow. The steps you need to follow to configure captures in SFCC depends on your capture setting in the Adyen Customer Area:

* [**Manual capture** ](/online-payments/capture/#manual-capture): you can capture payments from the OMS after they have been authorized.
* [**Automatic capture** ](/online-payments/capture): payments are captured automatically after authorization. You do not have to manually capture payments from the OMS. Our OMS package handles the automatic captures without disrupting the payment flow. If you have set up automatic capture in your Customer Area, follow the steps to [enable automatic captures with OMS](#enable-automatic-captures).

Regardless of your setting, payments for some payment methods are captured immediately after authorization. You must [specify these payment methods](#payment-methods-without-capture) in your Salesforce Business Manager to prevent duplicate capture requests.

### Enable automatic captures

To prevent OMS from making duplicate capture requests to Adyen when you have set up [automatic captures](/online-payments/capture) in your Adyen Customer Area, follow the steps below.

1. In your Salesforce OMS Org, go to **Setup** > **Custom Code** > **Custom Metadata Types**.

2. Select **Adyen Adapter**.

3. Scroll down to **Adyen Adapter Layout**, and select **Edit**.

4. Drag and drop the **Auto Capture Enabled** and **Manual Capture Payment Methods** fields to the **Adyen Adapter Layout**.

5. Select **Save**.

6. Select **Manage Adyen Adapters**.

7. Next to **Adyen Default**, select **Edit**.

8. Select the checkbox next to **Auto Capture Enabled**.\
   When you have set this up, OMS will process the payment record without an additional capture request, and the following payment gateway log will be created:

   ```text
   [capture-complete] Auto Capture enabled
   ```

9. For some payment methods, manual captures are required even when you have set up automatic captures in your Adyen Customer Area. In the **Manual Capture Payment Methods** field, specify the payment methods that require manual capture, using the [`paymentMethodVariant` ](/development-resources/paymentmethodvariant/)for each payment method. Separate each variant with a comma, for example:

   ```text
   klarna, klarna_account
   ```

10. Select **Save**.

### Specify payments without separate captures in SFCC

Payments for some payment methods are captured immediately after authorization regardless of your capture settings. You need to specify these payment methods that you enabled in the Adyen Customer Area in your Salesforce Business Manager. This prevents OMS from initiating duplicate capture requests.

1. In your [Salesforce Business Manager](/plugins/salesforce-commerce-cloud/sfra/set-up-the-cartridge/?plugin=Salesforce%20SFRA\&integration=cartridge\&version=latest#set-up-the-business-manager), go to **Merchant Tools** > **Site Preferences** > **Adyen settings** > **Local payment method settings**.
2. In the **Payment methods without separate capture** field, specify the payment methods that you added in your Customer Area. Separate each variant with a comma, for example:
   ```text
   ideal, paypal, applepay, visa_applepay, mc_applepay, amex_applepay, klarna_paynow, twint, sepadirectdebit, bcmc, wechatpay, multibanco, blik, mbway, pix, onlineBanking_PL
   ```
3. Select **Save Changes**.

## Go live

When you are ready to go live, [apply for a live account](/get-started-with-adyen/application-requirements). Review the process to start accepting payments on [Get started with Adyen](/get-started-with-adyen).

When you get your live account:

1. Follow our [SFCC go-live checklist](/plugins/salesforce-commerce-cloud/go-live-checklist). You do not need to follow the steps to [configure the SFCC Business Manager](/plugins/salesforce-commerce-cloud/go-live-checklist#business-manager) in the checklist.

2. Update the Adyen credentials you used to set up your Salesforce OMS Org:

   * In the [custom metadata record](#configure-adyen-custom-metadata):

     1. Update your HMAC key.
     2. If you are using a different merchant account in the live environment, update the merchant account name.

3. Switch the URL for the **Adyen Checkout** named credential to your live URL:

   1. In your OMS Org, go to **Setup** > **Security** > **Named Credentials**.
   2. Select the **Adyen Checkout** named credential.
   3. Replace the test URL with `https://[YOUR_LIVE_PREFIX]-checkout-live.adyenpayments.com/checkout`. [Get your live prefix](/development-resources/live-endpoints/#live-url-prefix) from the live Customer Area.

4. Switch your test API key to your live API Key:

   1. Select the **External Credential** linked to your **Adyen Checkout** named credential.
   2. Under **Principals**, update your API key authentication parameter to your live API key.

## Next steps

[Set up Order on Behalf Of](/plugins/salesforce-order-management-system/set-up-oobo)

[Enable your customer service employees to place orders on behalf of shoppers.](/plugins/salesforce-order-management-system/set-up-oobo)

[Enable Auhtorization Reversals](/plugins/salesforce-order-management-system/authorization-reversal)

[Handle situations where you need to reverse an authorization.](/plugins/salesforce-order-management-system/authorization-reversal)
