---
title: "Subscribe to notifications."
method: POST
path: "/createNotificationConfiguration"
---

# Subscribe to notifications.

`POST /createNotificationConfiguration`

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.

## 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.
    - `eventConfigs` NotificationEventConfiguration[], required — The types of events whose notifications apply to this configuration.
      - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_FUNDS_BELOW_THRESHOLD' | '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' | 'REFUND_FUNDS_TRANSFER' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'TRANSFER_FUNDS', 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`).
    - `hmacSignatureKey` string — A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted. >Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. "b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27"). The omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).
    - `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.
    - `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.
    - `eventConfigs` NotificationEventConfiguration[], required — The types of events whose notifications apply to this configuration.
      - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_FUNDS_BELOW_THRESHOLD' | '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' | 'REFUND_FUNDS_TRANSFER' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'TRANSFER_FUNDS', 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`).
    - `hmacSignatureKey` string — A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted. >Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. "b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27"). The omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).
    - `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.
    - `sslProtocol` 'SSL' | 'SSLInsecureCiphers' | 'TLS' | 'TLSv10' | 'TLSv10InsecureCiphers' | 'TLSv11' | 'TLSv12' — The SSL protocol employed by the endpoint. >Permitted values: `SSL`, `SSLInsecureCiphers`, `TLS`, `TLSv10`, `TLSv10InsecureCiphers`, `TLSv11`, `TLSv12`.
  - `invalidFields` ErrorFieldType[] — Contains field validation errors that would prevent requests from being processed.
    - `errorCode` integer — The validation error code.
    - `errorDescription` string — A description of the validation error.
    - `fieldType` FieldType
      - `field` string — The full name of the property.
      - `fieldName` 'accountCode' | 'accountHolderCode' | 'accountHolderDetails' | 'accountNumber' | 'accountStateType' | 'accountStatus' | 'accountType' | 'address' | 'bankAccount' | 'bankAccountCode' | 'bankAccountName' | 'bankAccountUUID' | 'bankBicSwift' | 'bankCity' | 'bankCode' | 'bankName' | 'bankStatement' | 'branchCode' | 'businessContact' | 'cardToken' | 'checkCode' | 'city' | 'companyRegistration' | 'constitutionalDocument' | 'country' | 'countryCode' | 'currency' | 'currencyCode' | 'dateOfBirth' | 'description' | 'destinationAccountCode' | 'document' | 'documentExpirationDate' | 'documentIssuerCountry' | 'documentIssuerState' | 'documentName' | 'documentNumber' | 'documentType' | 'doingBusinessAs' | 'drivingLicence' | 'drivingLicenceBack' | 'drivingLicense' | 'email' | 'firstName' | 'formType' | 'fullPhoneNumber' | 'gender' | 'hopWebserviceUser' | 'houseNumberOrName' | 'iban' | 'idCard' | 'idCardBack' | 'idCardFront' | 'idNumber' | 'identityDocument' | 'individualDetails' | 'jobTitle' | 'lastName' | 'legalArrangement' | 'legalArrangementCode' | 'legalArrangementEntity' | 'legalArrangementEntityCode' | 'legalArrangementLegalForm' | 'legalArrangementMember' | 'legalArrangementName' | 'legalArrangementReference' | 'legalArrangementRegistrationNumber' | 'legalArrangementTaxNumber' | 'legalArrangementType' | 'legalBusinessName' | 'legalEntity' | 'legalEntityType' | 'merchantAccount' | 'merchantCategoryCode' | 'merchantReference' | 'microDeposit' | 'name' | 'nationality' | 'originalReference' | 'ownerCity' | 'ownerCountryCode' | 'ownerHouseNumberOrName' | 'ownerName' | 'ownerPostalCode' | 'ownerState' | 'ownerStreet' | 'passport' | 'passportNumber' | 'payoutMethodCode' | 'personalData' | 'phoneCountryCode' | 'phoneNumber' | 'postalCode' | 'primaryCurrency' | 'reason' | 'registrationNumber' | 'returnUrl' | 'schedule' | 'shareholder' | 'shareholderCode' | 'shareholderType' | 'shopperInteraction' | 'signatory' | 'socialSecurityNumber' | 'sourceAccountCode' | 'splitAccount' | 'splitCurrency' | 'splitValue' | 'splits' | 'stateOrProvince' | 'status' | 'stockExchange' | 'stockNumber' | 'stockTicker' | 'store' | 'storeDetail' | 'storeName' | 'storeReference' | 'street' | 'taxId' | 'tier' | 'tierNumber' | 'transferCode' | 'unknown' | 'value' | 'verificationType' | 'virtualAccount' | 'visaNumber' | 'webAddress' | 'year' — The type of the field.
      - `shareholderCode` string — The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
  - `pspReference` string — The reference of a request. Can be used to uniquely identify the request.
  - `resultCode` string — The result code.

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

## Changes

- **2021-04-10** (v6) `320e4e7ebfa8` — 3 warning, 5 info
  - added the new `shopperInteraction` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200`
  - added the new `signatory` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200`
  - added the new `verificationType` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200`
  - added the optional property `status` to the response with the `400` status
  - …4 more
- **2021-03-26** (v6) `76291254288c` — 5 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - added the non-success response with the status `422`
  - …1 more
- …earlier changes not shown

[Full 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/320e4e7ebfa8/schema)