Deprecation of Adyen’s legacy notification framework

How can I identify if the legacy notification framework is still being used on my account(s)?

Adyen's legacy notification framework is configured at merchant account level. This means that in order to verify if you are still making use of our legacy notification framework, you will need to perform the following check within each one of your merchant accounts:

      1. Access the Customer Area
      2. Select the desired merchant account to be verified
      3. Hover over the 'Account' menu and within the 'Configure' section look for 'Notifications'

Note: The 'Notifications' button is only displayed if the legacy framework is being used. If the 'Notifications' button is not available, it means that you are using the new framework on the selected merchant account which is shown as 'Server Communication' within the menu.

Please make sure to verify all your merchant accounts so that all legacy notification endpoints are properly updated.

Can I migrate my account(s) from the legacy to the new notification framework?

Yes, migrating your notification endpoints to the new framework can be done by the steps below. Please make sure to migrate your accounts only once you are certain that you can accept the header used in our new notification framework.

      1. Access the Customer Area
      2. Select the desired merchant account that you would like migrate
      3. Hover over the 'Account' menu and within the 'Configure' section select 'Notifications'
      4. Within the 'Notification Migration' section, click the 'Migrate' button

mceclip0.png

Are there technical differences between Adyen's legacy and new notification framework?

Yes, there are two updates which you will need to prepare for:

1. HTTP Headers

Typically, no changes are required in your integration if you do not perform strict header field validations. Please note that Adyen does not advise to check for specific headers. It’s recommended to remove any checks on the HTTP headers as they might change in the future.

Merchants who do perform strict header field validations, will need to be ready to receive the new HTTP header used in our new notification framework. The required changes in the HTTP header will vary depending on the messaging protocol used in your integration:

a) Changes for SOAP:

Legacy Notification Framework New Notification Framework

Header (auth)

soapaction : ""

content-type : text/xml; charset=UTF-8

user-agent : Jakarta Commons-HttpClient/3.0.1

host : localhost:8080

content-lenght : 2974

Headers (auth)

soapaction : 

content-type : text/xml; charset= utf-8

content-lenght : 1585

host : localhost:8080

connection : Keep-Alive

user-agent : Adyen HttpClient 1.0

accept-encoding : gzip,deflate

 

b) Changes for HTTP:

Legacy Notification Framework New Notification Framework

Headers (auth)

content-type : application/x-www-form-urlencoded; charset=utf-8

content-length : 278

host : localhost:8080

connection : Keep-Alive

user-agent : Adyen HttpClient 1.0

accept-encoding : gzip,deflate

Headers (auth)

content-length : 488

content-type : application/x-www-form-urlencoded; charset=UTF-8

host : localhost:8080

connection : Keep-Alive

user-agent : Adyen HttpClient 1.0

accept-encoding : gzip,deflate

 

 

2. Additional Data in the body of the notification

The new framework is able to send over the additionalData objects various payment related fields to your system, such as card bin or fraud results, between others.

Within the new framework, an object named ‘additionalData' will always be included within all notifications.

Depending on your account settings, a customised selection of the available additionalData fields will be included within the body of the notification. This will be the same fields as the additionalData fields which you might already receive back in the API response.

Depending on your already existing account settings, a list of values will be returned in the additionalData object within each notification. For example:

additionalData" : {

      },

or "additionalData" : {
     "expiryDate" : "03\/2030",
     "authCode" : "085329",
     "cardSummary" : "1111"
    },

 

You can easily validate if your system is able to handle the additionalData object by performing some test transactions within the TEST environment and validating if the notifications are being successfully received in your system.

All additionalData fields can be configured at company or merchant account level. You can identify if additionalData fields are enabled on your company or merchant account by following these steps: 

      1. Access the Customer Area
      2. Hover over the 'Account' menu and within the 'Configure' section select 'API URLs'
      3. Within the 'API URLs and response' header, click on the 'Additional data settings' tab.

mceclip0.png

Note: To enable additionalData fields at a merchant account level, please access the merchant account before following the above mentioned steps.

The 'Response preview' window at the right side of your screen will list the additionalData items which are enabled.

What are the advantages of the new notification framework?

The new framework is more efficient. With the legacy framework you would receive two notifications for each authorisation. With the new framework we will just send one notification.

Also, the new framework is able to send over additionalData objects various payment related fields to your system, such as card bin or fraud results, between others.

Additionally, the new notification frameworks allows you to further protect your server from unauthorised notifications by setting up an HMAC signature on your notifications. This will allow you to verify the integrity of the notification content before it is processed by your system.

Can I roll back to Adyen's legacy notification framework?

No, it’s not possible to roll back to our legacy framework once a notifications endpoint is migrated.

Can I test the new notification framework?

Our new notification framework is already available within the TEST environment so that you can start validating your integration.

You can validate directly on the TEST environment by initiating some test transactions in order to verify that your system is able to accept the notifications via the new notification framework.

When is the end of life of the Adyen's legacy notification framework?

The end of life for Adyen's legacy notification framework is schedule for January 26th 2021. On this date, Adyen will take care of migrating to the new framework all remaining accounts that are still making use of our legacy notification framework in the LIVE environment.

Was this article helpful?
1 out of 1 found this helpful