Are you looking for test card numbers?

Would you like to contact support?

Plugin icon

Set up Adyen Customer Area

To use Adyen's plugin for Magento, you need to set up your Customer Area with Adyen.

Step 1: Generate an API key

For authenticating API requests from your Magento platform, you need to provide an API key. 

  1. Log in to your Customer Area.
  2. Go to Developers > API credentials, and select the API credential username for your integration, for example ws@Company.[YourCompanyAccount].
  3. Under Server settings > Authentication select the API key tab.
  4. Select Generate API key.
  5. Select the copy icon and store your API key securely in your system.
  6. Select Save changes.

You will need to enter the API key when configuring the plugin in Magento.

Step 2: Generate a client key

The plugin needs a client key to authenticate requests from your payment environment.

To generate a client key:

  1. Log in to your Customer Area.
  2. Go to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].
  3. Under Client settings > Authentication select the Client key tab.
  4. Select Generate client key.
  5. Select the copy icon and store your client key securely in your system.
  6. Under Add allowed origins, enter your domains and select Add.
  7. Select Save changes.

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 to inform your Magento platform of payment status changes. You need to configure standard notifications in the Customer Area and enable the OFFER_CLOSED event code. This event code ensures that expired payments are automatically closed, for example if the shopper abandons the payment session.

The default setting for an order expiration date depends on the payment method:

  • Card payments: 12 hours
  • Other payment methods: up to 28 days

If you want to change the default setting, contact our Support Team to configure a custom expiry date and specify the merchant accounts, schemes and timeframe in hours or days.

To set up notifications: 

  1. Log in to your Customer Area. If you want to configure webhooks for a merchant account, switch to that merchant account.
  2. Select Developers > Webhooks.
  3. Select + Webhook.
  4. Under Recommended webhooks > Standard notification select Add.
  5. Select the toggle to make the standard notification Enabled.
  6. Under General > Server configuration, select the edit icon . Enter:
    • URL: Your website URL followed by /adyen/process/json.
    • Method: JSON.
    • SSL Version: TLSv.1.2.
      Select Apply.
  7. Under General > Events, select the edit icon .
    • Select the checkbox for the OFFER_CLOSED event code.
      Select Apply.
  8. Under Security > Basic authentication, select the edit icon . Enter your server's username and password. You need to enter these credentials in the Magento admin panel later. Select Apply.
  9. Under Security > HMAC Key, select the edit icon . Select Generate. Copy the HMAC Key using the copy icon and store it safely in your system. You need to enter the HMAC key in the Magento admin panel later. Select Apply.
  10. Select Save changes.

Step 4 (optional): Set up capture delay

For credit cards, the payment is completed in two steps: 

  1. Authorisation – The payment details of the shopper are verified, and the funds are reserved.
  2. 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: 

  1. Log in to your Customer Area with your merchant account.
  2. Go to Settings > Account settings.
  3. 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).
  4. Select Submit.

Step 5 (optional): Set up case management behavior

For an extra layer of fraud protection, you may want to manually review a transaction before it is captured. A transaction can be sent to case management for manual review when it reaches a certain risk score or triggers a specific risk rule. For more information see Case management.

To use case management with the plugin:

  1. Log in to your Customer Area with your company account.
  2. Go to Risk > Settings.
  3. Select Global settings and scroll to Case management.
  4. Under Case management behavior select the following:
    • Accept: Select Capture and tick the Send notification box.
    • Reject: Select Cancel and tick the Send notification box.
    • Expire: Can be left None as this will be automatically handled by the plugin.

Next steps