Search

Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Set up the cartridge

Set up the cartridge in the Adyen Customer Area and in the Business Manager.

For older versions of the Adyen Payments Cartridge, see our older documentation. You can also learn more about how to migrate to Adyen Payments Cartridge version 20.1.0.

Before you begin

Before you begin, make sure that you have performed the following steps:

  1. Create a test account with Adyen. With this, you will be able to access the test Customer Area, and apply for a live account. While you wait for your live account credentials, you can start integrating by using your test account.
  2. Finish the metadata import.
  3. In Salesforce Commerce Cloud, enforce HTTPS.

    To be compatible with the Chrome v80 Cookie policy, you need to enforce the use of HTTPS for all sites.

     

Step 1: Set up the cartridge path

To set up the cartridge path in the Business Manager: 

  1. Go to Administration > Sites > Manage Sites > [yourSite] > Settings. 

  2. In the Cartridges box: 
    • If you are using SFRA, enter:
      int_adyen_SFRA:int_adyen_overlay:app_storefront_base
    • If you are using a controller-based SiteGenesis, enter:
      int_adyen_controllers:int_adyen_overlay:app_storefront_controllers:app_storefront_core
  3. Select Apply.

Step 2: Set up the Business Manager

In the following steps, you will need to copy over several settings from the Adyen Customer Area to the Business Manager.

  1. In the Business Manager, go to Merchant tools > Site Preferences > Custom Preferences > Adyen.

    Account structure

    With Adyen, you have a single company account, together with one or more merchant accounts.
    However, you can only have one merchant account for each storefront.

  2. In the merchantCode box, enter the name of your Adyen merchant account for which the payments will be processed. You can find this in the upper-right corner of your Customer Area.
  3. Set Test/Production mode to (TEST).
  4. Select Save in the upper-right corner of the screen.

Step 3: Connect your Commerce Cloud store to Adyen API

To connect your Commerce Cloud store to the Adyen API, you need to set up an API key in the Adyen Customer Area, and copy it over to the Business Manager. 

Set up an API key in the Adyen Customer Area

  1. In your Adyen Customer Area, go to Account > Users.
  2. From the drop-down menu in the first column, select System.
  3. Click on the ws user (ws@Company.[YourCompanyAccount]).
    This opens a page with the settings for this web service (ws) user.
  4. In the Authentication pane, select Generate New API Key.
  5. Copy the API key and store it securely in your system.
  6. Select Save Generated API Key.

Copy the API key over to the Business Manager

  1. In the Business Manager, go to Merchant tools > Site Preferences > Custom Preferences > Adyen.
  2. In the X-API-KEY of Web service box, enter the API key from your Adyen Customer Area.
  3. Select Save in the upper-right corner of the screen.

Step 4: Receive payment status updates

To inform your Commerce Cloud store of payment status changes, Adyen uses notifications, sent as HTTP callbacks (webhooks) to endpoints on your server. To receive notifications, you need to enter your server's details in the Adyen Customer Area, and copy over the notification credentials to the Business Manager.

Set up notifications in the Adyen Customer Area

  1. In the Adyen Customer Area, switch to your merchant-level account (by selecting the name of your merchant account in the upper-right corner). 
  2. Go to Account > Server Communications.
  3. Next to Standard Notification, select Add
  4. In the URL box, enter your website URL followed by /Adyen-Notify.
  5. From the SSL Version dropdown, select TLSv.1.2.
  6. Select the Active check box.
  7. From the Method dropdown, select HTTP POST.
  8. In the Authentication pane, enter a User Name and Password for notifications.
  9. Store these credentials securely in your system.
  10. Select Save Configuration.

Copy notification credentials over to the Business Manager

  1. In the Business Manager, go to Merchant tools > Site Preferences > Custom PreferencesAdyen.
  2. In the Adyen Notifications User and Adyen Notifications Password box, enter the username and password for notifications from your Adyen Customer Area.
  3. Select Save in the upper-right corner of the screen.

Test notifications

Test whether notifications have been configured correctly:

  1. In the Adyen Customer Area, switch to your merchant-level account (by selecting the name of your merchant account in the upper-right corner). 
  2. Go to Account > Server Communications.
  3. Next to Standard Notification, select Edit & Test
  4. In the Test Notifications pane, select Test Configuration
  5. If the result is [Accepted], your notifications are working correctly.

Configure scheduled jobs

Notifications are stored in Commerce Cloud as custom object instances to be processed by scheduled jobs.

After the metadata import, a scheduled job with ID Process is added to the Business Manager: Administration > Operations > Jobs. This scheduled job has two steps (you can check this in the Job Steps tab): 

  • Process – Processes the notification and updates the payment status of the order.
  • Clean –  Deletes the custom object instance, once it has been processed.

We recommend that you set the frequency of this scheduled job to 1 minute: 

  1. Go to the Schedule and History tab for the Process scheduled job.
  2. Set Trigger to Recurring Interval.
  3. In the Run Time pane, set Amount to 1, and Interval to Minutes

Step 5 (optional): Store shopper details

Adyen can securely store payment details of your shoppers. To set this up:

For more information about recurring transaction types, refer to Recurring payments.

  1. In the Business Manager, go to Merchant tools > Site Preferences > Custom Preferences > Adyen.
  2. Store shopper details: recurring. Select Yes to enable stored payment methods for recurring transactions, where you can complete the payment without the shopper being present.
  3. Store shopper details: one-click. Select Yes to enable stored payment methods for one-click transactions, where the shopper needs to enter their CVC/CVV to complete the payment.
  4. Enable the Guest user shopper reference, when storing shopper details of guest users. Go to Site Preferences > Order > Generate Customer No. for Guest Orders > Yes.

Step 6 (optional): Accept donations

With Adyen Giving, your shoppers can seamlessly donate to charities of your choice at the checkout page of your website. To learn more about Adyen Giving, see Donations.

To use Adyen Giving with your Salesforce Commerce Cloud cartridge:

  1. Onboard with Adyen Giving.
  2. In the Business Manager, go to Merchant tools > Site Preferences > Custom Preferences > Adyen and set the following configurations:
Field Description
Enable Adyen Giving Set to True to enable Adyen Giving.
Charity name Name of the charity displayed on the Adyen Giving component.
Charity merchant account Merchant account name for charity.
Amounts for donation Suggested amounts that the shopper can choose to donate.
Description of charity Description of the charity.
Website from charity Link to the charity website.
Background image for Adyen Giving component Background image of the Adyen Giving component.
Logo in Adyen Giving component Logo displayed on the Adyen Giving component.
  1. In the Adyen Customer Area, go to Account > API URLs.
  2. Go to Additional data settings.
  3. In the Card section, select the Variant check box.

Step 7 (optional): Basket fields

You can use Basket fields for custom risk rules. To include the Basket fields in your payment request:

  1. In the Business Manager, go to Merchant tools > Site Preferences > Custom Preferences > Adyen.
  2. Set Basket fields to true.

See also

Next steps