This page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our new integration guide instead.
All Platforms API create, update, and delete requests are asynchronous, so you must rely on notifications to know the final result of a request. These notifications are sent as webhooks to the corresponding URLs configured on your server.
On this page you'll learn how to:
- Create a configuration for each notification type that you want to receive from Adyen for Platforms.
- Get information about existing notification configurations.
- Test your notification set up.
- Update existing notification configurations.
- Delete notification configurations.
You also need to accept each notification, to confirm that you have received it.
Create a notification configuration
To configure a notification, make a POST /createNotificationConfiguration call and pass the URL where the notifications should be sent and the notification types that you want to receive. You can also provide the message format, protocol, username, password, and other parameters, as shown in the example below.
Get a configuration
To get the details of a previously configured notification, make a POST /getNotificationConfiguration call and pass the notification ID as a parameter.
Get a list of configurations
In addition, you can get a list of all configured notifications. For this, make the /getNotificationConfigurationList call and pass an empty request as a parameter.
Update notification configurations
To change notification settings, make a POST /updateNotificationConfiguration call and pass new settings as its parameters. The notification to be updated is specified by the notificationId
value.
Delete notification configurations
If you no longer need some of configured notifications, delete them by making a POST /deleteNotificationConfigurations call. Notifications to be deleted are specified by the IDs in the notificationIds
array.
Accept notifications
To confirm that you have received a notification, your server should acknowledge the notification with the following response:
[accepted]
We use at-least-once delivery to ensure that your server has received a notification. If your server has not acknowledged a notification within 10 seconds we will queue all notifications to this endpoint. We'll then retry sending the notification until it is accepted. Once accepted, you'll receive all your queued notifications.
Retry attempts will happen regularly, at increasing time intervals:
- 2 minutes
- 5 minutes
- 10 minutes
- 15 minutes
- 30 minutes
- 1 hour
- 2 hours
- 4 hours
Retries then happen every 8 hours for the following 7 days.
Test a notification
To test a notification configuration, make a POST /testNotificationConfiguration call and pass a notificationId
as a parameter. If you leave the eventTypes
array empty, all the configured notification types will be generated.