Adding an Adyen Connection

Modified on Fri, 4 Oct at 4:54 PM

Adding an Adyen connection to your BR-DGE retail channel requires you to collect some information for us to add to your BR-DGE retail channels. This article details the information BR-DGE requires, and how you can locate it.

Adyen Account

If you don't already have an Adyen Account, then you will need to create one with Adyen.

BR-DGE requires the following information to allow you to route payments to Adyen through our platform:

Merchant Account Name
Server to Server API key
Webhook HMAC Signing Key
URL Prefix (Production Only)

Please note that some of these details are sensitive. We ask you to handle these with care.

How to locate your Merchant Account Name?

Login to the Adyen Portal for the relevant environment
Navigate to Settings > Merchant Account
Copy the Merchant Account Name for the account you are interested in

How to generate your Server to Server API Key?
- Go to Developers > API Credentials and create a new API credential
- Under Server Settings > Authentication select the API key tab.
- Select Generate API Key.
- Select the copy icon.
- Select Save Changes.

How to create your Webhook HMAC Signing Key?
- Login to the Adyen portal for the relevant environment.
- Navigate to Developers > Webhooks.
- Select the Webhook button in the upper right corner.
- Add a standard webhook.
- Under General add the following details to configure the webhook:
  - Method: JSON
  - Encryption Protocol: TLSv1.3
  - Events
    - AUTHORISATION
    - CAPTURE
    - REFUND
    - CAPTURE_FAILED
    - REFUND_FAILED
  - Security
    - Generate a HMAC key and store it securely. This should be provided to BR-DGE as the key we will use to authenticate Adyen webhooks
  - Webhook URLs:

Sandbox: sandbox.comcarde.com/v1/notifications/adyen/{RetailChannelId}
Production: secure.comcarde.com/v1/notifications/adyen/{RetailChannelId}

BR-DGE will need to provide your Retail Channel ID for the corresponding Retail Channel in advance. Please get in contact with Customer Support to get this information.

How to locate your URL Prefix?
- Login to the Adyen live customer area.
- Navigate to Developers > API URLs > Prefix.
- Locate the URL for your company account.

Additional Configuration Steps:

To process transactions with Adyen via BR-DGE you need to ensure that your Adyen account has the the manual capture feature set to OFF. By default, this feature is disabled on all new Adyen accounts. However, if this feature is enabled on your account, you can follow the steps detailed on the Adyen website to turn it off: Capture | Adyen Docs.

For Refunds, the payment needs to be in Captured status. If you have set up a delay between the authorisation and the automatic capture of the payment, please ensure this is set to “immediate”.

To allow multiple partial captures, you need to contact Adyen directly and ask them to enable the feature on your account: Capture | Adyen Docs

If you are processing merchant initiated transactions (MIT) via Adyen you need to ensure that the following additional data settings are enabled in your Adyen account.

Log in to your Customer Area.
Go to Developers > Additional data.
Enable the following fields:
- In the Acquirer section: Network Transaction Reference
Select Save configuration.

If you are processing transactions using Network Tokens you need to ensure that the following additional data settings are enabled in your Adyen account.

Log in to your Customer Area.
Go to Developers > Additional data.
Enable the following fields:
- In the Acquirer section: Network Transaction Reference
- In the Card section: Card bin and Card summary
Select Save configuration.