Search

Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Microsoft Dynamics 365

Set up the Adyen payment connector for Dynamics 365

Go to our company website to learn about the advantages of using the Adyen connector for Dynamics 365.

When you use Microsoft Dynamics 365 Commerce as your omnichannel solution, the Dynamics 365 Payment Connector for Adyen allows you to process payments across your sales channels through the Adyen payments platform. With the Adyen payment connector you can accept:

  • All major global credit and debit cards, both online and in-store.
  • In-store transactions with Givex and SVS gift cards.
  • In-store transactions with Android Pay, Apple Pay, and Samsung Pay wallets.

You can use the Adyen payment connector with all Dynamics 365 Commerce channels:

  • Modern POS (MPOS) - Interfaces with the Adyen Terminal API using local communications. It allows you to continue processing payments when offline, and to access payment terminals, printers, and cash drawers directly.
  • Cloud POS (CPOS) - Interfaces with the Adyen Terminal API using cloud communications. It runs in a browser and therefore can't work offline and can only access the payment terminals, printers, and cash drawers through a hardware station.
  • e-Commerce - Interfaces with the Adyen Checkout API.
  • Call Center - Interfaces with the Adyen Checkout API.

Before you begin

Before you set up the Adyen payment connector, make sure you have performed the following steps:

  1. Sign up for a test account with Adyen.
    You'll get:
    • A company account with one associated merchant account.
    • Access to the test Customer Area where you can configure your account.
  2. If you use more than one sales channel, for example MPOS and e-Commerce, request additional merchant accounts. You need have a separate merchant account for each channel.
  3. Apply for a live account with Adyen.

While you wait for your live account, you can proceed with the steps to:

  1. Configure your Adyen account.
  2. Order Adyen payment terminals for your MPOS or CPOS retail channel (if applicable).
  3. Set up the Adyen payment connector in Dynamics 365.

Step 1: Configure your Adyen account

Our Support Team will take care of part of your account configuration. But there are a few steps that you need to do yourself. The most important step is to create separate API credentials for each of your sales channels.

Select the following tabs to see what you need to do for MPOS, CPOS, e-Commerce, or Call Center.

  1. Log in to your Customer Area and make sure you are on the company account level (in the top-right corner, under the name of your company account, no merchant selected is shown).
  2. Create a new API credential for MPOS:
    Do not use or configure the default API credential ws@Company.[YourCompanyAccount] that was created when you signed up with Adyen.
    1. Go to Account > API credentials.
    2. Select Add new credential.
    3. Under User Account Details, select the user type Webservice.
    4. Make a note of the generated User Name.
    5. Under Authentication, select Generate New API Key.
    6. Copy and securely store the API key in your system.
      You will need to add this API key in the Dynamics 365 configuration for MPOS.
      If you lose this API key you won't be able to restore it later.
    7. Under Roles and Associated Accounts, enable the following roles:
      • Merchant Recurring Role
      • Submit POS Payment
      Our Support Team will enable more roles for you:
      • POS initial Configuration
      • Terminal Registration Role
      • Terminal Management API Role
      • Device with Payload Encryption Role
      • Allow firmware download for POS devices
    8. Select Save.
  3. Configure response settings:
    1. Switch to the merchant account you created for MPOS.
    2. Go to Account > API URLs and select the tab Additional data settings.
    3. Select the Toggle all fields check box.
    4. Deselect the check box under Risk.
  4. Make sure no capture delay is set:
    1. In your MPOS merchant account, go to Account > Settings.
    2. From the POS Capture Delay list, select Immediate.
  5. Contact our Support Team and ask them to configure the back-office for you. Let them know:
    • The name of your MPOS merchant account.
    • The name of the API credential you created for MPOS, so that they can enable the remaining roles.
    • Whether you process Givex or SVS gift cards.
  1. Log in to your Customer Area and make sure you are on the company account level (in the top-right corner, under the name of your company account, no merchant selected is shown).
  2. Create a new API credential for CPOS:
    Do not use or configure the default API credential ws@Company.[YourCompanyAccount] that was created when you signed up with Adyen.
    1. Go to Account > API credentials.
    2. Select Add new credential.
    3. Under User Account Details, select the user type Webservice.
    4. Make a note of the generated User Name.
    5. Under Authentication, select Generate New API Key.
    6. Copy and securely store the API key in your system.
      You will need to add this API key in the Dynamics 365 configuration for MPOS.
      If you lose this API key you won't be able to restore it later.
    7. Under Roles and Associated Accounts, enable the following roles:
      • Merchant Recurring Role
      • Submit POS Payment
      Our Support Team will enable more roles for you:
      • POS initial Configuration
      • Terminal Registration Role
      • Terminal Management API Role
      • Device with Payload Encryption Role
      • Allow firmware download for POS devices
    8. Select Save.
  3. Configure response settings:
    1. Switch to the merchant account you created for CPOS.
    2. Go to Account > API URLs and select the tab Additional data settings.
    3. Select the Toggle all fields check box.
    4. Deselect the check box under Risk.
  4. Make sure no capture delay is set:
    1. In your CPOS merchant account, go to Account > Settings.
    2. From the POS Capture Delay list, select Immediate.
  5. Contact our Support Team and ask them to configure the back-office for you. Let them know:
    • The name of your CPOS merchant account.
    • The name of the API credential you created for CPOS, so that they can enable the remaining roles.
    • Whether you process Givex or SVS gift cards.
  1. Log in to your Customer Area and make sure you are on the company account level (in the top-right corner, under the name of your company account, no merchant selected is shown).
  2. Create a new API credential for eCommerce:
    Do not use or configure the default API credential ws@Company.[YourCompanyAccount] that was created when you signed up with Adyen.
    1. Go to Account > API credentials.
    2. Select Add new credential.
    3. Under User Account Details, select the user type Webservice.
    4. Make a note of the generated User Name.
    5. Under Authentication, select Generate New API Key.
    6. Copy and securely store the API key in your system.
      You will need to add this API key in the Dynamics 365 configuration for MPOS.
      If you lose this API key you won't be able to restore it later.
    7. Under Roles and Associated Accounts, enable the following roles:
      • API Clientside Encryption Payments Role
      • API Payment RefundWithData
      • Checkout encrypted cardholder data
      • Checkout Webservice role
      • General API Payments Role
      • Merchant PAL Webservice Role
      • Merchant Recurring Role
    8. If you'll use V002 of the Adyen payment connector:
      • Under Origin key, enter your website's domain, then select Generate Origin Key.
        Use a concatenation of the protocol, host, and port. Do not include subdirectories or a trailing slash. For example, https://your-company.com or https://checkout.your-company.com:8080. You can also confirm this by opening the browser console and calling window.location.origin.
      • Copy and safely store the origin key in your system. You will need to add this key in the Dynamics 365 configuration.
    9. Select Save.
  3. Configure response settings:
    1. Switch to the merchant account you created for eCommerce.
    2. Go to Account > API URLs and select the tab Additional data settings.
    3. Select the Toggle all fields check box.
    4. Deselect the check box under Risk.
  4. Contact our Support Team and ask them to configure the back-office for you. Let them know:
    • The name of your eCommerce merchant account.
    • Whether you process unreferenced refunds.
    • Whether you process Givex or SVS gift cards.
  1. Log in to your Customer Area and make sure you are on the company account level (in the top-right corner, under the name of your company account, no merchant selected is shown).
  2. Create a new API credential for Call Center:
    Do not use or configure the default API credential ws@Company.[YourCompanyAccount] that was created when you signed up with Adyen.
    1. Go to Account > API credentials.
    2. Select Add new credential.
    3. Under User Account Details, select the user type Webservice.
    4. Make a note of the generated User Name.
    5. Under Authentication, select Generate New API Key.
    6. Copy and securely store the API key in your system.
      You will need to add this API key in the Dynamics 365 configuration for MPOS.
      If you lose this API key you won't be able to restore it later.
    7. Under Roles and Associated Accounts, enable the following roles:
      • API Clientside Encryption Payments Role
      • Checkout encrypted cardholder data
      • Checkout Webservice role
      • General API Payments Role
      • Merchant PAL Webservice Role
      • Merchant Recurring Role
    8. Select Save.
  3. Configure response settings:
    1. Switch to the merchant account you created for Call Center.
    2. Go to Account > API URLs and select the tab Additional data settings.
    3. Select the Toggle all fields check box.
    4. Deselect the check box under Risk.
  4. Contact our Support Team and ask them to configure the back-office for you. Let them know:
    • The name of your Call Center merchant account.

Step 2 (MPOS or CPOS): Get your Adyen payment terminals

For your MPOS or CPOS channel, the Adyen payment connector can only communicate with payment terminals that are injected with Adyen software. To obtain these terminals:

  1. Create store IDs for the stores where you are using MPOS or CPOS.
  2. Select the terminal models that suit your business.
  3. Order test terminals and a test card from your test Customer Area.
  4. Board your terminals to associate them with a store and make them ready to accept test payments.

Step 3: Set up Dynamics 365

To set up and configure the Adyen payment connector in Dynamics 365 Commerce:

  1. Follow the instructions in the Dynamics 365 Commerce documentation.

  2. For e-Commerce and Call Center: When requested to specify the Optional Domain, you can leave this field blank for the test environment. But when going live you must provide your Adyen merchant prefix, otherwise you get a PaymentException error. To find your merchant prefix:

    1. Log in to your live Customer Area and select your merchant account.
    2. Go to Account > API URLs. The merchant prefix is a value formatted like this example: de05272d410af88d-YOUR_COMPANY.

  3. For CPOS: When requested to specify the Optional Domain, you can leave the field blank in the test environment. When going live, specify https://terminal-api-live.adyen.com/sync.

  4. When requested to set up a POS hardware profile for the Adyen payment terminals you are using with MPOS or CPOS, find the required values as follows:

    1. Log in to your Customer Area.
    2. Go to Point of sale > Terminals and select your terminal.
    3. On the Settings page, find:

      • The terminal's IP address under Connectivity.
      • The POIID, in the format [device model]-[serial number], in the page title.
      • The Key identifier, Key passphrase, and Key version under Integrations > Encryption key.

Test and go live

Test your integration

Before you start accepting payments, test your integration:

  1. Use our test card numbers to test online payments and/or use your test terminal and test card to test in-person payments.

    To test Givex gift cards, ask your Givex contact for the credentials to supply to Adyen.

    When a test gift card needs to be reset, contact the provider (SVS or Givex).

  2. Test all the payment methods that you would like to offer in each channel that you're using.
  3. Review details on each test payment in your test Customer Area.

Go live

When you have a live Adyen account and the credentials for your live Customer Area:

  1. If you use more than one sales channel, for example MPOS and e-Commerce, request additional merchant accounts. You need have a separate live merchant account for each channel.
  2. If you're using MPOS or CPOS:
    1. Create store IDs under your live merchant account.
    2. Order live terminals from your live Customer Area.
    3. Board your terminals to make them ready to accept live payments.
  3. Configure your live Adyen account as described in Step 1.
  4. In Dynamics 365 Headquarters, do the following:
    • Set Gateway environment to Live.
    • Enter the Optional Domain. Refer to Step 3 and the Prerequisites in the Dynamics 365 documentation for the Adyen payment connector.