Setup and Credentials for Adyen

In order to connect your Brand to your Adyen account for processing eCommerce payments (from Mobile, Web and select External Channels), there is configuration that is required to be set up in your Adyen account and you need to provide your Success Manager with certain credentials from your Adyen account. This article will take you through the steps of performing the setup and locating the credentials needed.

The following credentials need to be provided to your Success Manager:

• Client Encryption Public Key

• API Key

• Client Authentication Public Key

• Default Merchant Account

• Live URL Prefix

• Merchant Account (per Venue or Company / Franchisee, depending on setup)

Fig.1 Adyen configuration in PAR Ordering CMS

Storing Tokens at a Company-level

By default Adyen stores card tokens (cards that your users save to their account on Mobile and Web) per Merchant Account. If you plan to use multiple Merchant Accounts for your Brand (in order to wire funds to different bank accounts based on the Venue where a transaction is made), you need to reach out to the Adyen Support and ask them to configure your account so that card tokens are stored at a Company-level, rather than per Merchant Account.

Here is a template that you can use to reach out to Adyen:

Dear Adyen Support,

Since card tokens are stored per Merchant Account by default and we would like to enable our users to use their saved card across multiple Merchant Accounts when they purchase at different stores, we'd like to kindly ask you to configure our Adyen account <Put your Account ID here> to store card tokens at a Company-level, rather than per Merchant Account.

I would also kindly ask you if you could enable a browserInfo auto-fill option in the account configuration. This attribute is required for 3DSv1 requests, even if the request comes from the native/Mobile app. 

Thank you

Client Encryption Public Key

• Log in to your Adyen account

• Navigate to Developers -> API credentials

• Click on Create credential

• On the Create New Web Service User page, click on Generate in the Client-Side Encryption section

  • Make note of the Client Encryption Public Key (copy it to your machine for later usage)

  • PAR Ordering is using this key to client-side encrypt cardholder data. This public key is not secret.

Fig.2 Generate a Client Encryption Public Key

API Key

• Click on Generate New API Key in the Authentication section
  PAR Ordering needs the API key to authenticate with the Adyen webservice.

• Make note of the API Key shown and then click on Save Generated API Key (the API Key will disappear once you click the button)
  After saving, the newly generated API Key will not be visible anymore. Adyen does not store or display passwords or keys in plain text. If you forgot your key, you may regenerate it. The old key will remain valid for 24 hours after generating a new one.

Fig.3 Generate Adyen API Key

Client Authentication Public Key

• Still in Authentication section, click on Generate New Client Key and copy it to your local machine. This is the Client Authentication Public Key that you’ll need to provide to your PAR Ordering Success Manager.

• • In the Allowed origins section, enter the name of the domain where the application is hosted (e.g. https://*.menu.app or https://*.mydomain.com) and click on Add Origin

Fig.4 Inserting allowed origins

• In the Roles section, make sure to enable all needed roles (typically all listed)

Fig.5 Enable Adyen Roles

• In the Accounts section, make sure your Company is enabled as well as all the Merchant Accounts that you'd like to process payments for. Likely you'll want to enable all of them. Note that in case you add Merchant Accounts later on, you'll need to edit your existing WebService user and enable the new Merchant Accounts for the user.

Fig.6 Enable the Adyen Accounts

• Click on Save at the bottom of the page

Default Merchant Account & Merchant Account per Venue

Per Venue payments can be processed through a different Merchant Account.

The Default Merchant Account is the Merchant Account through which payments will be processed in case no Merchant Account has been configured for a Venue.

To see a list of your Merchant Accounts or to select a different Merchant Account, click on the name of the current Merchant Account in the top left corner of the screen.

Fig.7 Select Merchant Accounts

Let your Success Manager know which Merchant Account should be configured as your Default, as well as which Merchant Account should be configured for each one of your Venues (if needed).

Live URL Prefix

• Navigate to Developers → API URLs

• You will find a list of URLs on the page. For the Action Authorise, your Live URL Prefix are the characters shown before .adyen.com.

• In the screenshot below, the Live URL Prefix is pal-test.

Fig.8 How to find Live URL Prefix in Adyen API URLs list.

Additional Data

In order to integrate Adyen with PAR Ordering platform properly, the additional data must also be configured:

• Log in to your Adyen account

• Navigate to Developers → Additional data

• Toggle the additional data checkboxes as shown in the screenshot below 

Fig. 9 Additional Data to configure

Sending the credentials to your PAR Ordering Success Manager

The secret key is considered sensitive data. Please make sure that the key is only made available to the right persons.

Do not send the secret key through unsecured Email !

To send the credentials (Secret Key and Public Key) to your PAR Ordering Success Manager in a safe way, there are several alternatives:

• Paste them in a text-file, create a compressed zip-file with a strong password. Send the zip file and the password on two separate channels (e.g. Email and Slack)

• Provide the text-file from a secured file sharing site and share the access URL and password over a secure channel.