Search

Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Set up the app

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

Before you begin

Make sure that you have:

  • Created 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. 

Step 1: Connect your B2B Commerce store to Adyen API

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

To connect your B2B Commerce 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 the Adyen Customer Area, go to Account > Users.
  2. From the drop-down menu in the first column, select System.
  3. Click the ws user (ws@Company.[YourCompanyAccount]).
    This opens a page with the settings for this web service (ws) user.
  4. In the Authentication pane, click Generate New API Key.
  5. Copy the API key and store it securely in your system.
  6. Click Save Generated API Key.
  7. Contact our Support Team so that they can enable the API PCI Payments role for the system user.

Copy the API key over to the Setup Menu

  1. In the Business Manager, go to the Settings icon and click Setup.
  2. In the menu, under Platform Tools, go to Apps > Packaging > Installed Packages.
  3. In the Installed Packages list, go to Adyen Payments App - B2B Commerce and select Configure.
  4. Click New to create new settings for the package in your Setup Menu.
  5. Fill out the following and click Save:

    Field Description
    Merchant Name Your Adyen merchant account name for which the payments will be processed.
    Payment Endpoint The Authorise endpoint from your Adyen Customer Area > Account > API URLs.
    For the test environment, this field is already filled in.
    Capture Endpoint The Capture endpoint from your Adyen Customer Area > Account > API URLs.
    For the test environment, this field is already filled in.
    Authorise Endpoint The Recurring /disable endpoint from your Adyen Customer Area > Account > API URLs.
    For the test environment, this field is already filled in.
    Disable Endpoint The Checkout API /payments endpoint from your Adyen Customer Area > Account > API URLs.
    For the test environment, this field is already filled in.
    API Key Your API key from Adyen Customer Area.

Set up additional data in API response in the Adyen Customer Area

  1. Log in to your Customer Area with your merchant-level account.
  2. Go to Account > API URLs, and switch to the Additional data settings tab.
  3. Enable the following fields:
    • Card > Card summary
    • Payment > Recurring details
  4. Click Save configuration in the action bar below.

Set up the capture delay in the Adyen Customer Area

For credit cards, the payment is completed in two steps: 

  1. Authorisation – The payment details of the shopper are verified, and the funds are reserved.
  2. Capture – The reserved funds are transferred from the shopper to your account. 

You can either perform the capture manually in Salesforce, or have it happen automatically after the payment has been authorised. In case of automatic capture, you can choose whether payments are captured immediately after authorisation, or after some fixed number of days. 

The default setting is immediate automatic capture. 

To set up the capture delay:

  1. In the Adyen Customer Area, go to Account > Users.
  2. In the Capture Delay drop-down menu, select one of the following: 
    • manual if you want to capture all payments manually in Salesforce.
    • the number of days between authorisation and automatic capture.
    • immediate if you want payments to be captured immediately after authorisation (this is the default setting).
  3. Click Submit.

Set up the configuration in the CC Admin

  1. In the Business Manager, open B2B Commerce from the App Launcer and switch to the CC Admin tab.
  2. In the menu, select Configuration Settings.
  3. Set the fields as follows:

    Module Configuration Value
    Adyen Credit Card Config Metadata Your Adyen merchant account name for which the payments will be processed.
    Adyen Credit Card Immediate Capture The capture delay that you set in your Adyen Customer Area.
    Possible values:
    • FALSE – Select this if you set capture delay to manual (manual capture).
    • TRUE – Select if you set capture delay to immediate, or to some fixed number of days (automatic capture).
    Checkout Payment Types adyencc
    To set multiple values in this field, list them using commas without spaces.
    My Wallet Enabled TRUE
    My Wallet Payment adyen_bundlepmt_adyencc_pay,adyen_bundle__pmt_adyencc_edit,adyen_bundlepmt_adyencc_new
    To set multiple values in this field, list them using commas without spaces.
    My Wallet Payments adyencc
    To set multiple values in this field, list them using commas without spaces.

    These values can be set at a global level or at the storefront level.

Step 2: Set up the Business Manager

Configure the Setup Menu

  1. In the Business Manager, go to the Settings icon and click Setup.
  2. In the menu, under Settings, go to Security > Remote Site Settings.
  3. Select New Remote Site to add the following remote sites:

    Remote site name Remote Site URL Disable Protocol Security Active
    Adyen_Checkout_API_for_test https://checkout-test.adyen.com -x- -white_check_mark-
    Adyen_Checkout_API_for_live https://checkout-live.adyen.com -x- -white_check_mark-
    Adyen_PAL_API_for_test https://pal-test.adyen.com -x- -white_check_mark-
    Adyen_PAL_API_for_live https://pal-live.adyen.com -x- -white_check_mark-

Set up viewing transaction payments

  1. In the menu, under Platform Tools, go to Objects and Fields > Object Manager.
  2. Select CC Order from the list.
  3. In the Page Layout Editor, select Related Lists from the menu on the left. You should now be able to see the Related Lists section.
  4. Add the CC Transaction Payment box from the Page Layout Editor to the Related Lists section. You should now see CC Transaction Payments as a an entry.
  5. Click the Related List Properties spanner, just above the CC Transaction Payments entry.
  6. Add the Account Number, Account Type and Transaction Type from the Available Fields to the Selected Fields and click Save.
  7. Click Save in the Page Layout Editor. Select Yes when the prompt asking if you want to overwrite users' related list customizations appears.

Configure the B2B Commerce CC Admin

Set up integrations

  1. In the Business Manager, open B2B Commerce from the App Launcer and switch to the CC Admin tab.
  2. Select your storefront from the Global Settings dropdown on the right side of the screen.
  3. In the menu, under Integrations, go to Payments.
  4. In the Payment Hook Settings for DefaultStore section, set the Payment Hook API Class to adyen_bundle.cc_adyencc_hk_Payment.
  5. Click Save.

Set up cache

  1. Click the Global Settings option on the right side of the screen.
  2. In the menu, select Configuration Cache Management.
  3. Select Build New and wait for a new configuration cache to build. You may need to click Refresh List to see the new cache and its build status.
  4. Activate the new configuration cache.
  5. Deactivate (and optionally Remove) any previous configuration caches.

Optional configuration: Manual captures

If you're going to capture payments manually in Salesforce, do the following:

Before you begin

  1. In the Business Manager, go to the Settings icon and click Setup.
  2. In the menu, under Platform Tools, go to Objects and Fields > Object Manager.
  3. In the Object Manager list, select CC Transaction Payment.

Add capture payment to transaction page (Salesforce Classic)

  1. In the menu, select Search Layouts for Salesforce Classic.
  2. In the Search Layouts list, go to List View and edit it.
  3. In the List View Actions in Lightning Experience section, select Capture from the Available Quick Actions and Add it to the Selected Quick Actions.
  4. Click Save.

Add capture payment to the CC Transaction Payment's actions

  1. In the menu, under Platform Tools, go to Objects and Fields > Object Manager.
  2. Select CC Transactions Payment from the list.
  3. In the menu, select Page Layouts.
  4. In the Page Layout Editor, select Mobile & Lightning Actions from the menu to the left.
  5. Add the Capture action from the Page Layout Editor to the Salesforce Mobile and Lightning Experience Actions.
  6. Click Save in the Page Layout Editor.

How to capture payments manually

  1. Log into your Salesforce Business Manager.
  2. Open B2B Commerce from the AppLauncher.
  3. Go to the CC Orders tab and open the order that you want to capture the payment for.
  4. Go to the Related tab and, under the CC Transaction Payments section, click on the Transaction Payment entry.
  5. Select the Capture button in the top right-hand corner of the page.
  6. Click Save.

The Transaction Code field represents the PSP reference generated by Adyen's system.

You can make the capture payment visible to certain users by adding Adyen - Standard User Permission Set.

Next steps