integrations.sh
← all integrations

adyen.com – NotificationConfigurationService

OpenAPI apis-guru payment

This API is used for the classic integration. If you are just starting your implementation, refer to our 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 .

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 .

Versioning

The Notification Configuration API supports 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/v1/createNotificationConfiguration
Homepage
https://api.apis.guru/v2/specs/adyen.com:NotificationConfigurationService/1.json
Provider
adyen.com:NotificationConfigurationService / NotificationConfigurationService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/NotificationConfigurationService/1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/NotificationConfigurationService/1/openapi.yaml

Tools (8)

Extracted live via the executor SDK.

  • general.postCreateNotificationConfiguration

    Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.

  • general.postDeleteNotificationConfigurations

    Deletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.

  • general.postGetNotificationConfiguration

    Returns the details of the configuration of a notification subscription.

  • general.postGetNotificationConfigurationList

    Returns the details of the configurations of all of the notification subscriptions in the platform of the executing user.

  • general.postTestNotificationConfiguration

    Tests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.

  • general.postUpdateNotificationConfiguration

    Updates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools