Adyen

Notification Configuration API

This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead.

The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.

For more information, refer to our documentation.

Authentication

Your Adyen contact will provide your API credential and an API key. To connect to the API, add an X-API-Key header with the API key as the value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...

Alternatively, you can use the username and password to connect to the API using basic authentication. For example:

curl
-U "ws@MarketPlace.YOUR_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \
-H "Content-Type: application/json" \
...

When going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

The Notification Configuration API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration

Endpoints 6

General

  • POSTSubscribe to notifications/createNotificationConfigurationCreates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration…
  • POSTDelete a notification subscription configuration/deleteNotificationConfigurationsDeletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined…
  • POSTGet a notification subscription configuration/getNotificationConfigurationReturns the details of the configuration of a notification subscription.
  • POSTGet a list of notification subscription configurations/getNotificationConfigurationListReturns the details of the configurations of all of the notification subscriptions in the platform of the executing user.
  • POSTTest a notification configuration/testNotificationConfigurationTests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured…
  • POSTUpdate a notification subscription configuration/updateNotificationConfigurationUpdates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous…

API details

Base URL
https://cal-test.adyen.com/cal/services/Notification/v6
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
6 operations on 6 pathsPOST 6
Main resources
General 6
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 6

How to test the Notification Configuration API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Notification Configuration API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Subscribe to notifications” (POST /createNotificationConfiguration), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Notification Configuration API?

This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration… It is listed under Payments and has 6 endpoints.

Who publishes the Notification Configuration API?

It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Notification Configuration API?

Requests go to https://cal-test.adyen.com/cal/services/Notification/v6. Endpoint paths are added to this base URL.

How do I authenticate with the Notification Configuration API?

It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the Notification Configuration API have?

6 operations on 6 paths (6 POST). The largest groups are General.

Is forking the Notification Configuration API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.