Adyen Notification Configuration API
The Notification Configuration API is used for the classic integration to configure notification subscriptions, endpoints, and settings.
OpenAPI Specification
openapi: 3.1.0
servers:
- url: https://cal-test.adyen.com/cal/services/Notification/v6
info:
version: '6'
x-publicVersion: true
title: Adyen Notification Configuration API
description: >-
This API is used for the classic integration. If you are just starting your
implementation, refer to our [new integration
guide](https://docs.adyen.com/marketplaces-and-platforms) 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](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).
## 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 "[email protected]_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](https://docs.adyen.com/development-resources/live-endpoints).
## Versioning
The Notification Configuration API supports
[versioning](https://docs.adyen.com/development-resources/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
```
x-timestamp: '2023-05-30T15:27:19Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
x-groups:
- General
tags:
- name: createNotificationConfiguration
- name: deleteNotificationConfigurations
- name: getNotificationConfiguration
- name: getNotificationConfigurationList
- name: testNotificationConfiguration
- name: updateNotificationConfiguration
paths:
/createNotificationConfiguration:
post:
tags:
- createNotificationConfiguration
summary: Adyen Subscribe to Notifications
description: >-
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.
operationId: post-createNotificationConfiguration
x-groupName: General
x-sortIndex: 1
x-methodName: createNotificationConfiguration
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-createNotificationConfiguration-basic
schema:
$ref: '#/components/schemas/CreateNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-createNotificationConfiguration-basic-200
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-createNotificationConfiguration400Example:
summary: Default post-createNotificationConfiguration 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-createNotificationConfiguration401Example:
summary: Default post-createNotificationConfiguration 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-createNotificationConfiguration403Example:
summary: Default post-createNotificationConfiguration 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-createNotificationConfiguration422Example:
summary: Default post-createNotificationConfiguration 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-createNotificationConfiguration500Example:
summary: Default post-createNotificationConfiguration 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/deleteNotificationConfigurations:
post:
tags:
- deleteNotificationConfigurations
summary: Adyen Delete a Notification Subscription Configuration
description: >-
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.
operationId: post-deleteNotificationConfigurations
x-groupName: General
x-sortIndex: 6
x-methodName: deleteNotificationConfigurations
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-deleteNotificationConfigurations-basic
schema:
$ref: '#/components/schemas/DeleteNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-deleteNotificationConfigurations-basic-200
schema:
$ref: '#/components/schemas/GenericResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deleteNotificationConfigurations400Example:
summary: Default post-deleteNotificationConfigurations 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deleteNotificationConfigurations401Example:
summary: Default post-deleteNotificationConfigurations 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deleteNotificationConfigurations403Example:
summary: Default post-deleteNotificationConfigurations 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deleteNotificationConfigurations422Example:
summary: Default post-deleteNotificationConfigurations 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-deleteNotificationConfigurations500Example:
summary: Default post-deleteNotificationConfigurations 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/getNotificationConfiguration:
post:
tags:
- getNotificationConfiguration
summary: Adyen Get a Notification Subscription Configuration
description: Returns the details of the configuration of a notification subscription.
operationId: post-getNotificationConfiguration
x-groupName: General
x-sortIndex: 2
x-methodName: getNotificationConfiguration
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-getNotificationConfiguration-basic'
schema:
$ref: '#/components/schemas/GetNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-getNotificationConfiguration-basic-200
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfiguration400Example:
summary: Default post-getNotificationConfiguration 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfiguration401Example:
summary: Default post-getNotificationConfiguration 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfiguration403Example:
summary: Default post-getNotificationConfiguration 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfiguration422Example:
summary: Default post-getNotificationConfiguration 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfiguration500Example:
summary: Default post-getNotificationConfiguration 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/getNotificationConfigurationList:
post:
tags:
- getNotificationConfigurationList
summary: Adyen Get a List of Notification Subscription Configurations
description: >-
Returns the details of the configurations of all of the notification
subscriptions in the platform of the executing user.
operationId: post-getNotificationConfigurationList
x-groupName: General
x-sortIndex: 3
x-methodName: getNotificationConfigurationList
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-getNotificationConfigurationList-basic
schema:
$ref: '#/components/schemas/EmptyRequest'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-getNotificationConfigurationList-basic-200
schema:
$ref: '#/components/schemas/GetNotificationConfigurationListResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfigurationList400Example:
summary: Default post-getNotificationConfigurationList 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfigurationList401Example:
summary: Default post-getNotificationConfigurationList 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfigurationList403Example:
summary: Default post-getNotificationConfigurationList 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfigurationList422Example:
summary: Default post-getNotificationConfigurationList 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-getNotificationConfigurationList500Example:
summary: Default post-getNotificationConfigurationList 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/testNotificationConfiguration:
post:
tags:
- testNotificationConfiguration
summary: Adyen Test a Notification Configuration
description: >-
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.
operationId: post-testNotificationConfiguration
x-groupName: General
x-sortIndex: 4
x-methodName: testNotificationConfiguration
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-testNotificationConfiguration-basic'
schema:
$ref: '#/components/schemas/TestNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-testNotificationConfiguration-basic-200
schema:
$ref: '#/components/schemas/TestNotificationConfigurationResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-testNotificationConfiguration400Example:
summary: Default post-testNotificationConfiguration 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-testNotificationConfiguration401Example:
summary: Default post-testNotificationConfiguration 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-testNotificationConfiguration403Example:
summary: Default post-testNotificationConfiguration 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-testNotificationConfiguration422Example:
summary: Default post-testNotificationConfiguration 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-testNotificationConfiguration500Example:
summary: Default post-testNotificationConfiguration 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/updateNotificationConfiguration:
post:
tags:
- updateNotificationConfiguration
summary: Adyen Update a Notification Subscription Configuration
description: >-
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.
operationId: post-updateNotificationConfiguration
x-groupName: General
x-sortIndex: 5
x-methodName: updateNotificationConfiguration
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-updateNotificationConfiguration-basic
schema:
$ref: '#/components/schemas/UpdateNotificationConfigurationRequest'
responses:
'200':
content:
application/json:
examples:
basic:
$ref: >-
#/components/examples/post-updateNotificationConfiguration-basic-200
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-updateNotificationConfiguration400Example:
summary: Default post-updateNotificationConfiguration 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-updateNotificationConfiguration401Example:
summary: Default post-updateNotificationConfiguration 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-updateNotificationConfiguration403Example:
summary: Default post-updateNotificationConfiguration 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-updateNotificationConfiguration422Example:
summary: Default post-updateNotificationConfiguration 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-updateNotificationConfiguration500Example:
summary: Default post-updateNotificationConfiguration 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
CreateNotificationConfigurationRequest:
properties:
configurationDetails:
description: Details of the prospective notification subscription configuration.
$ref: '#/components/schemas/NotificationConfigurationDetails'
required:
- configurationDetails
type: object
DeleteNotificationConfigurationRequest:
properties:
notificationIds:
description: >-
A list of IDs of the notification subscription configurations to be
deleted.
items:
format: int64
type: integer
type: array
required:
- notificationIds
type: object
EmptyRequest:
type: object
ErrorFieldType:
properties:
errorCode:
description: The validation error code.
format: int32
type: integer
errorDescription:
description: A description of the validation error.
type: string
fieldType:
description: The type of error field.
$ref: '#/components/schemas/FieldType'
type: object
ExchangeMessage:
properties:
messageCode:
type: string
messageDescription:
type: string
type: object
FieldType:
properties:
field:
description: The full name of the property.
type: string
fieldName:
description: The type of the field.
enum:
- accountCode
- accountHolderCode
- accountHolderDetails
- accountNumber
- accountStateType
- accountStatus
- accountType
- address
- balanceAccount
- balanceAccountActive
- balanceAccountCode
- balanceAccountId
- bankAccount
- bankAccountCode
- bankAccountName
- bankAccountUUID
- bankBicSwift
- bankCity
- bankCode
- bankName
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/notification-configurations-openapi-original.yml