Adyen

Table of contents

• Prerequisites & Limitations
• Configuration of your Adyen account
  • Setting Capture delay
  • Activating recurring tokens
  • Generating an endpoint for live payment transactions
• Configuration in billwerk and Adyen
  • Opening the Adyen settings 
  • Selecting Merchant Account
  • Activating Recurring details
  • Generating API Key
  • Generating Client Key
  • JS Library Location (deprecated)
  • Generating HMAC Key
  • Subscribing Payment accounting
  • Reporting User Name and Password
  • Live Endpoint
  • Configuring SEPA reference line
• Test data
  • Credit Card
  • SEPA Direct Debit

Prerequisites & Limitations

Before you set up Adyen integration, you should collect the following parameters:

• API Key
• Client Key
• HMAC Key

Please be aware before starting your implementation of SubscriptionJS on your sign up page, that not all of the proposed payment methods of this PSP support the ProcessPaymentData method:

Configuration of your Adyen account

Contact Adyen to activate all payment methods you need. billwerk supports credit card payments, SEPA direct debit payments and iDeal. 

If you already have an Adyen account and want to update your settings to use the new Adyen integration, check directly the Generating Client Key section.

Setting Capture delay

In your Adyen account, set the Capture delay to manual.

1. Switch from the company account to the merchant account on the top-right. 
2. In your Adyen merchant account, select Settings > Account settings from the left-hand side menu. 
3. In the Capture delay setting, select manual.
   
4. Click Save.

Activating recurring tokens

In your Adyen account, activate the recurring tokens.

1. In your Adyen merchant account, select Settings > Checkout settings from the left-hand side menu. 
2. In the Recurring section, activate the recurring tokens by moving the toggle button to the right.
   

Generating an endpoint for live payment transactions

Contact the Adyen support to generate an endpoint for live payment transactions for you. If Adyen has already generated the endpoint, you can view the endpoints in the API URLs section.

• In your Adyen merchant account, select Developers > API URLs from the left-hand side menu. 

Configuration in billwerk and Adyen

Opening the Payment Settings

Prepare the configuration in billwerk by opening the settings of the payment provider Adyen.

1. To get to the Payment Settings, click on your email address > Settings in the top right corner.
2. In the PAYMENT section, click Payment Settings.
3. In the Adyen row, click the icon.
   

Selecting Merchant Account

Enter the name of your Adyen merchant account as it appears in the Adyen user interface. The merchant account is marked in the following screenshot.

Activating Recurring details

1. In your Adyen merchant account, select Developers > Additional Data from the left-hand side menu. 
2. Activate under Payment the checkbox Recurring details.

Generating API Key

Generate a new API key in Adyen and paste it in billwerk.

1. In your Adyen merchant account, select Developers > API Credentials from the left-hand side menu.
2. Select the user ws@[your company name].
3. In the Authentication section, click on Generate New API Key. 
   
4. In billwerk, paste the generated API Key in the API Key field in the Adyen settings.
   
5. Finish this step in Adyen by pressing Save Generated API Key. 

Generating Client Key

Adyen API for Credit Cards requires Client Key to be saved in billwerk. This step is required for merchants who want to switch from old Adyen Credit Card implementation to a new one.

1. In your Adyen merchant account, select Developers > API Credentials from the left-hand side menu.
2. Select the user ws@[your company name].
3. In the Authentication section, click on Generate New Client Key.
   
4. In billwerk, paste the generated Client Key in the Client Key field in the Adyen settings.
   

Every input for entering card sensitive data is hosted on Adyen side and present as iFrame on the page. If you are using your own sign-up page, please note, we are not loading new Adyen JS library automatically as for other PSPs, because additional objects should be created client side. The instructions and detailed description you can find here.

If you are using our hosted pages, no additional changes needed.

JS Library Location (deprecated)

1. In your Adyen merchant account, select Settings > Users from the left-hand side menu. 
2. Select the user ws@[your company name].
3. In the Client-Site Encryption section, copy the Library location link.
4. Paste the link in billwerk.

Generating HMAC Key

You have to activate the Standard Notifications in Adyen for the HMAC key.

1. In your Adyen merchant account, select Developers > Webhooks from the left-hand side menu. 
2. Click on the + Webhook button to add Standard Notifications and to open a dialog box.
3. In your billwerk account, click on the Profile icon in the top-right corner to open the Settings menu.
4. Select Settings.
5. On the Settings page, choose Payment Settings from the left-hand side pane.
6. Click on the Edit icon by Adyen.
7. Copy the link from the Adyen Account Requirements box on the Settings Adyen page.
8. In Adyen, paste the URL into the URL field in the General > Server Configuration section.
   
9. Click Apply.
10. Click Generate in the Security > HMAC Key section.
    
11. Copy the HMAC key.
12. In billwerk, paste the HMAC key into the HMAC Key field.
13. In Adyen, click Apply.
14. Click Save Changes.
15. Activate the Standard notification.
    
    
    

Subscribing Payment accounting

After configuring the notifications, you must now also subscribe to "Payment accounting".

1. Select Reports from the left-hand side menu. 
2. In the Payment accounting section, ensure that Automatic generation is enabled with .CSV as report type.
   

Reporting User Name and Password

A separate Adyen Reporting user is required to call up the reports.

1. Select Developers > API Credentials from the left-hand side menu. 
2. Click on Create credential.
   
3. Select Report user as the user type.
   
   A username and password will be created automatically.
4. You can then transfer username and password to the billwerk payment settings.
   
5. Make sure that Merchant Report Download role is selected.
   

Live Endpoint

In Live Mode, the Live Endpoint generated in the Generating an endpoint for live payment transactions section must be stored.

Configuring SEPA reference line

You can configure the SEPA reference line manually. For more information, see the article Configuring SEPA reference.

Test data

Credit Card

Visa

Mastercard

Discover

Diners Club

American Express

Cartes Bancaires

SEPA Direct Debit

If you are looking for additional test data, you can find the full list in the official Adyen documentation.