​
Setup

Adyen provides a self-service sign-up for a sandbox account. To sign up for an account visit the sign-up page and fill in the details.

​
Credentials

To set up credentials for Adyen, head to their dashboard and navigate to Developers -> API credentials in the left hand sidebar. Next, create a set of credentials. You will need to create a Web Service key and give it a name. We recommend setting the name to something that describes the use for the key, e.g. “Orchestration API”. For most Adyen connectors you will need to then copy some of the following details into our dashboard.
  • A server-side API key - This key can be found on the credentials page under Server Settings -> Authentication -> API key. This is the key we will use to communicate with the Adyen API from our server.
  • A client-side key - This key can be found on the credentials page under Client Settings -> Authentication -> Client key. This is the key we will use to communicate with the Adyen API from our frontend integrations. This key is mostly needed for local and alternative payment methods.
  • A merchant account - This is the public ID of your account. We need this value for most API calls. You can find this in your dashboard under Settings -> Account settings -> Merchant overview -> Name.

​
Productions endpoints (conditional)

Most live Adyen accounts have a custom API hostname configured. In those situations we need to know the value of the prefix of your domain name. For example, if your live URL is https://1797a841fbb37ca7-AdyenDemo-checkout-live.adyenpayments.com/checkout/v53/payments then the live URL prefix would be 1797a841fbb37ca7-AdyenDemo. See Live URL prefix for more details.

​
Allowed origins (conditional)

For alternative payment methods it’s essential to also enable the allowed origin for your instance. This will allow us to connect to the Adyen API from our hosted components, like Embed. For a given API credential, scroll down to the Client settings section where you will find the allowed origins configuration. Add one of the following domains based on your environment.
  • https://cdn.{instance_id}.gr4vy.app
  • https://cdn.sandbox.{instance_id}.gr4vy.app
The value of {instance_id} is the name of your instance.

​
Web Components Environment (conditional)

It is required to set the environment to load the web components from for live Adyen transactions. This mainly applies to alternative payment methods and not card payments. The environment should be set to one of the following, depending on your region. If no value is provided, a default value of live is used.
RegionEnvironment Value
Europelive
Australialive-au
USlive-us
Asia Pacific South Eastlive-apse

​
Webhook format

In the Adyen panel, “Webhook configuration” section, “Method” should be set to JSON. Adyen webhook format