Search

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. 

To generate an API Key:

  1. Log in to your Customer Area.
  2. Go to Account > Users, and click the user ws@Company.[YourCompanyAccount].
  3. Under Authentication, click Generate New API Key
    Copy and securely store the API Key in your system – you will need it later when configuring the plugin in Magento.
  4. Click Save at the bottom of the page.

    Before going live, make sure that your web service user has the Checkout webservice role. If you need to enable this role, contact our Support Team.

Step 2: 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: 

  1. Log in to your Customer Area with your company-level account.
  2. Go to Account > Server Communication.
  3. Next to Standard Notification, click Add
  4. In the URL box, enter your website URL followed by /adyen/process/json.
  5. Select the Active checkbox.
  6. Set Method to JSON.
  7. 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.

  8. Click Save Configuration.

Step 3 (optional): Set 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. In case of automatic capture, you can choose whether payments are captured immediately after authorisation, or after some fixed number of days. The default setting is immediate automatic capture. 

To change the capture delay: 

  1. Log in to your Customer Area with your merchant-level account.
  2. Go to 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.
    • the number of days between authorisation and automatic capture.
    • immediate if you want payments to be captured immediately after authorisation (this is the default setting).
  4. Click Submit.

Step 4 (optional): Set up vault payments

Vault payments allow your shoppers to make instant purchases. To enable vault payments:

  1. Log in to your Customer Area with your merchant-level account.
  2. Go to Account > API URLs.
  3. In the Additional data in API response section, select:
    • Card summary
    • Expiry Date
    • Cardholder name
    • Recurring details
    • Variant

This allows the vault token to be created after a successful authorisation.

Step 5 (optional): Set up billing agreements

Billing agreements allow your shoppers to save their payment details. To enable billing agreements:

  1. Log in to your Customer Area with your merchant-level account.
  2. Go to Account > API URLs.
  3. In the Additional data in API response section, select:
    • Card summary
    • Expiry Date
    • Cardholder name
    • Recurring details
    • Variant

This allows the billing agreement to be created after a successful authorisation.

Next steps