Salesforce Order Management System

The Adyen Payments App - Order Management System (OMS) is an order management solution for your ecommerce site. The integration works together with payment solutions provided by either:

• Salesforce Commerce Cloud
• Salesforce B2B Commerce Lightning

The Salesforce Order Management System is a single platform for managing orders, customer records, fulfillment, inventory visibility, payments and invoicing, and customer care.

Payment methods

The supported payment methods for Salesforce OMS includes the supported payment methods for:

• Salesforce Commerce Cloud (SFCC)

Install the app

To install the app, search for Adyen Payments App - Order Management System in the Salesforce AppExchange and follow the instructions.

Step 1. Create a Named Credential

The Named Credential has the authentication details used between the Salesforce Order Management System and Adyen.

1. From Setup, go to Security > Named Credentials

2. Create a new Named Credential with these properties:

   Field	Value
   Label	Adyen
   Name	Adyen
   URL	https://pal-test.adyen.com
   Identity Type	Select Named Principal
   Authentication Protocol	Select Password Authentication
   Username	The name of your Adyen API Credential, for example ws@Company.[YourAdyenCompanyAccount].
   Password	The basic authentication password for your Adyen API Credential
   Callout options	Select the checkbox for: - Generate Authorization Header - Allow Merge Fields in HTTP Body

If you have multiple sales channels, each with its own Adyen merchant account, make sure the Adyen API credential has permission to access to all these merchant accounts.

Step 2. Configure sales channels

For each of your sales channels, the Salesforce Order Management System adds an Adyen Merchant Account field. Fill in this field with the name of the Adyen merchant account you're using for that sales channel.

Then add details about each Adyen merchant account:

1. From Setup go to Custom Code > Custom Metadata Types.
2. On Adyen Adapter type, select Manage Records.
3. Add a new record for each Adyen Merchant Account value in your Sales Channels configuration:
   • Label: A unique label.
   • Adyen Adapter Name: Get the value from the sales channel. This links the Adyen merchant account to the sales channel on Salesforce.
   • Endpoint Path: /pal/servlet/Payment
   • Endpoint API Version: /v52
   • Endpoint Method: POST
   • Capture Endpoint: /capture
   • Refund Endpoint: /refund
   • Merchant Account: The name of your Adyen merchant account. Case-sensitive.
4. Select Save to complete.

Step 3. Set up the Payment Gateway

To set up the Payment Gateway:

1. Create a Payment Gateway Provider record.
2. Create a Payment Gateway record.

Create the Payment Gateway Provider record

First, get the Apex Adapter ID:

1. From Setup go to Custom Code > Apex Classes
2. Choose AdyenAsyncAdapter class.
3. Make a note of the final part of the URL in your browser, for example 01pB0000004IvhM. This is the Apex Adapter ID.

Then, use Workbench to add the Payment Gateway Provider record:

1. Log in to Workbench.

2. Choose API v49.

3. Select Utilities > REST Explorer.

4. Make a POST /services/data/v49.0/tooling/sobjects/PaymentGatewayProvider request with the following body:

   {
   "ApexAdapterId": "YOUR_APEX_ADAPTER_ID",
   "DeveloperName": "Adyen",
   "MasterLabel": "SalesforceOrderManagement-Adyen",
   "IdempotencySupported": "Yes"
   }

5. You get a confirmation if the Payment Gateway Provider record was created successfully.

Create a Payment Gateway record

1. In the Order Management app, select App Switcher and type Payment Gateways.

2. Select New, and enter the following values:

   Field	Value
   Payment Gateway Name	Adyen
   Payment Gateway Provider	Choose the Payment Gateway Provider you created.
   Merchant Credential	Adyen. This is the Named Credential you created.
   Status	Active
   External Reference	Adyen_Component. This value must match your SFCC B2C Payment Processor ID.

3. Select Save to finish.

Step 4. Set up webhook notifications

Adyen uses webhooks to send JSON notifications asynchronously to your Salesforce payment gateway adapter. To receive these notifications, you need to:

1. Expose a Salesforce site endpoint.
2. Configure webhook notifications in the Adyen Customer Area.
3. Test your webhook configuration.

Expose a Salesforce site endpoint

This site will accept Adyen's webhook notifications.

1. From Setup, go to User Interface > Sites and Domains - Sites, and then select Site.
2. Select New.
3. Enter a label, for example Adyen. Select Active.
4. Enter a unique value for the default web address, for example http://dev-myorganization--sandbox.cs17.force.com/adyen
5. Select Guest Access to the Payments API, and then save your changes.
6. Select an Active Site Home Page, for example, UnderConstruction, and Save your changes.
7. Activate the site.
8. Go to Public Access Settings > Custom Metadata Types. Select Edit and enable the Adyen Adapter metadata type.

To construct the webhook endpoint URL you need:

• The URL of your Salesforce site.
• The Payment Gateway Provider ID you got when creating the payment gateway provider record.

SALESFORCE_SITE_URL/services/data/v49.0/commerce/payments/notify?provider=YOUR_PAYMENT_GATEWAY_PROVIDER_ID
# For example:
# http:// dev-clientname.cs17.force.com/adyen/services/data/v49.0/commerce/payments/notify?provider=0cJ4W000000XWnuUAG

Configure notifications in the Adyen Customer Area

1. Log in to your Customer Area. If you want to configure webhooks for a merchant account, switch to that merchant account.
2. Select Developers > Webhooks.
3. Select + Webhook.
4. Under Recommended webhooks > Standard notification select Add.
5. Select the toggle to make the standard notification Enabled.
6. Select the edit icon for Server configuration.
7. Enter:
   • URL: The webhook endpoint URL you constructed.
   • Method: Select JSON.
   • SSL Version: Select TLSv1.2.
     Select Apply.
8. Under General > Events, select the edit icon . Remove all events except CAPTURE and REFUND. Select Apply. Contact our Support Team to enable this if you don't have access.
9. Select Save changes.

Test your webhook configuration

1. In your Customer Area, go to Developers > Webhooks.
2. Next to Standard notification, select the edit webhook icon .
3. Under Test Notifications, toggle which notifications you want to test.
4. Select Test Configuration.

Seeing [accepted] in all of the test results confirms your webhook configuration is correct.

See also