Step 1: Generate an API key
For authenticating API requests from your Magento platform, you need to provide an API key.
- Log in to your Customer Area.
- Go to Developers > API credentials, and select the credential for your integration, for example ws@Company.[YourCompanyAccount].
- Under Authentication, select Generate New API Key.
- Copy and securely store the API key in your system — you won't be able to restore it later.
If your API key is lost or compromised, you need to generate a new one.
- Select Save at the bottom of the page.
You will need to enter the API key when configuring the plugin in Magento.
Step 2: Generate a client key
The plugin needs the client key to show the input fields for card details.
The client key is linked to one or more allowed origins — the domains from which we expect to get your client-side requests. For example, if you're collecting shopper's payment information at:
https://example.org/checkout, you would need to link the domain
https://example.org as an allowed origin to your client key.
To generate a client key:
- Log in to your Customer Area.
- Go to Developers > API credentials, and select the API credential for your integration, for example ws@Company.[YourCompanyAccount].
- Add your domains under Allowed origins. These are the domains from which you will be sending your client-side requests.
- Under Authentication, select Generate New Client Key.
- Select Save.
You now have a client key for your test environment. To get a client key for your live environment, follow the same steps in your live Customer Area.
You will need to copy the test and live client keys and add them in the Magento admin panel.
Step 3: Set up notifications
Adyen uses notifications, our webhook service, to inform your Magento platform of payment status changes. For more information, refer to Notifications.
To receive notifications:
- Log in to your Customer Area with your company-level account.
- In the upper-right corner, select the + Webhook button.
- Next to Standard notification, select Add.
- In the URL box, enter your website URL followed by /adyen/process/json.
- From the SSL Version list, select TLSv.1.2.
- Select the Active check box.
- Set Method to JSON.
- In the Authentication section, in the User Name and Password boxes, enter a username and password for basic authentication. You also need to enter these credentials in the Magento admin panel.
- In the Additional Settings section, next to HMAC Key (HEX Encoded), select Generate new HMAC key. Store the generated key in your password management tool. You also need to enter the HMAC key in the Magento admin panel.
HMAC signature validation is supported from plugin version 6.2.0 and later.
- Select Save Configuration.
Step 4 (optional): Set capture delay
For credit cards, the payment is completed in two steps:
- Authorisation – The payment details of the shopper are verified, and the funds are reserved.
- Capture – The reserved funds are transferred from the shopper to your account.
You can either perform the capture manually in Magento, or have it happen automatically after the payment has been authorised.
To change the capture delay:
- Log in to your Customer Area with your merchant-level account.
- Go to Account > Settings.
- In the Capture Delay drop-down menu, select one of the following:
- manual if you want to capture all payments manually in Magento.
- immediate if you want payments to be captured immediately after authorisation (this is the default setting).
- Select Submit.