---
title: "Configure a new subscription to notifications."
method: POST
path: "/createNotificationConfiguration"
---

# Configure a new subscription to notifications.

`POST /createNotificationConfiguration`

This endpoint is used to create a subscription to MarketPay event notifications. 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.

## Request body

- CreateNotificationConfigurationRequest
  - `configurationDetails` NotificationConfigurationDetails, required
    - `active` boolean — Indicates whether the notification subscription is active.
    - `apiVersion` integer — The API version of the notification to send.
    - `description` string — A description of the notification subscription configuration. >Required when creating a configuration, forbidden when updating a configuration.
    - `eventConfigs` NotificationEventConfiguration[], required — The types of events whose notifications apply to this configuration.
      - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_HOLDER_CREATED' | 'ACCOUNT_HOLDER_LIMIT_REACHED' | 'ACCOUNT_HOLDER_PAYOUT' | 'ACCOUNT_HOLDER_STATUS_CHANGE' | 'ACCOUNT_HOLDER_STORE_STATUS_CHANGE' | 'ACCOUNT_HOLDER_UPCOMING_DEADLINE' | 'ACCOUNT_HOLDER_UPDATED' | 'ACCOUNT_HOLDER_VERIFICATION' | 'ACCOUNT_UPDATED' | 'BENEFICIARY_SETUP' | 'COMPENSATE_NEGATIVE_BALANCE' | 'DIRECT_DEBIT_INITIATED' | 'PAYMENT_FAILURE' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'TRANSFER_FUNDS' | 'TRANSFER_FUNDS_REFUND', required — The type of event triggering the notification. >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
      - `includeMode` 'EXCLUDE' | 'INCLUDE', required — Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent. >Permitted values: `INCLUDE`, `EXCLUDE`. >- `INCLUDE`: send the specified eventType. >- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).
    - `messageFormat` 'JSON' | 'SOAP' — The data format of the notification to be sent. >Permitted values: `JSON`, `SOAP`.
    - `notificationId` integer — The ID of the configuration. >Required if updating an existing configuration, ignored during the creation of a configuration.
    - `notifyPassword` string — The password to use when accessing the notifyURL with the specified username.
    - `notifyURL` string, required — The URL to which the notifications are to be sent.
    - `notifyUsername` string — The username to use when accessing the notifyURL.
    - `sendActionHeader` boolean — Indicates whether an action header should be included. >Only applies to SOAP messages (as specified in messageFormat).
    - `sslProtocol` 'SSL' | 'SSLInsecureCiphers' | 'TLS' | 'TLSv10' | 'TLSv10InsecureCiphers' | 'TLSv11' | 'TLSv12' — The SSL protocol employed by the endpoint. >Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.

## Response `200`

OK - the request has succeeded.

- GetNotificationConfigurationResponse
  - `configurationDetails` NotificationConfigurationDetails, required
    - `active` boolean — Indicates whether the notification subscription is active.
    - `apiVersion` integer — The API version of the notification to send.
    - `description` string — A description of the notification subscription configuration. >Required when creating a configuration, forbidden when updating a configuration.
    - `eventConfigs` NotificationEventConfiguration[], required — The types of events whose notifications apply to this configuration.
      - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_HOLDER_CREATED' | 'ACCOUNT_HOLDER_LIMIT_REACHED' | 'ACCOUNT_HOLDER_PAYOUT' | 'ACCOUNT_HOLDER_STATUS_CHANGE' | 'ACCOUNT_HOLDER_STORE_STATUS_CHANGE' | 'ACCOUNT_HOLDER_UPCOMING_DEADLINE' | 'ACCOUNT_HOLDER_UPDATED' | 'ACCOUNT_HOLDER_VERIFICATION' | 'ACCOUNT_UPDATED' | 'BENEFICIARY_SETUP' | 'COMPENSATE_NEGATIVE_BALANCE' | 'DIRECT_DEBIT_INITIATED' | 'PAYMENT_FAILURE' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'TRANSFER_FUNDS' | 'TRANSFER_FUNDS_REFUND', required — The type of event triggering the notification. >Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.
      - `includeMode` 'EXCLUDE' | 'INCLUDE', required — Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent. >Permitted values: `INCLUDE`, `EXCLUDE`. >- `INCLUDE`: send the specified eventType. >- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).
    - `messageFormat` 'JSON' | 'SOAP' — The data format of the notification to be sent. >Permitted values: `JSON`, `SOAP`.
    - `notificationId` integer — The ID of the configuration. >Required if updating an existing configuration, ignored during the creation of a configuration.
    - `notifyPassword` string — The password to use when accessing the notifyURL with the specified username.
    - `notifyURL` string, required — The URL to which the notifications are to be sent.
    - `notifyUsername` string — The username to use when accessing the notifyURL.
    - `sendActionHeader` boolean — Indicates whether an action header should be included. >Only applies to SOAP messages (as specified in messageFormat).
    - `sslProtocol` 'SSL' | 'SSLInsecureCiphers' | 'TLS' | 'TLSv10' | 'TLSv10InsecureCiphers' | 'TLSv11' | 'TLSv12' — The SSL protocol employed by the endpoint. >Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.
  - `pspReference` string, required — The reference of a request. Can be used to uniquely identify the request.
  - `resultCode` string — The result code.
  - `submittedAsync` boolean, required — Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied: * **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable. * **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received. * **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.

## Changes

- **2020-03-04** (v1) `8521f7daecb4` — 9 breaking, 8 warning, 22 info
  - added the new required request property `configurationDetails/eventConfigs/items/eventType`
  - added the new required request property `configurationDetails/eventConfigs/items/includeMode`
  - the request's body type/format changed from `object`/`` to ``/``
  - the request property `configurationDetails/eventConfigs` became required
  - …35 more

[Change history](https://skmtc.dev/adyen/apis/notificationconfigurationservice/changes/createNotificationConfiguration/post.md)

---

[API](https://skmtc.dev/adyen/apis/notificationconfigurationservice.md) · [All operations](https://skmtc.dev/adyen/apis/notificationconfigurationservice/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/notificationconfigurationservice/revisions/8521f7daecb4/schema)