---
title: "Update a notification subscription configuration"
method: POST
path: "/updateNotificationConfiguration"
tags: ["General"]
---

# Update a notification subscription configuration

`POST /updateNotificationConfiguration`

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.

## Request body

- UpdateNotificationConfigurationRequest
  - `configurationDetails` NotificationConfigurationDetails, required
    - `active` boolean — Indicates whether the notification subscription is active.
    - `apiVersion` integer — The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.
    - `description` string — A description of the notification subscription configuration.
    - `eventConfigs` NotificationEventConfiguration[] — Contains objects that define event types and their subscription settings.
      - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_FUNDS_BELOW_THRESHOLD' | 'ACCOUNT_HOLDER_CREATED' | 'ACCOUNT_HOLDER_LIMIT_REACHED' | 'ACCOUNT_HOLDER_MIGRATED' | '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' | 'FUNDS_MIGRATED' | 'PAYMENT_FAILURE' | 'PENDING_CREDIT' | 'REFUND_FUNDS_TRANSFER' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'SCORE_SIGNAL_TRIGGERED' | 'TRANSFER_FUNDS' | 'TRANSFER_NOT_PAIDOUT_TRANSFERS', required — The type of event. Possible values: **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**.
      - `includeMode` 'EXCLUDE' | 'INCLUDE', required — Indicates whether the specified `eventType` is sent to your webhook endpoint. Possible values: * **INCLUDE**: Send the specified `eventType`. * **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **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 — Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).
    - `notifyPassword` string — The password to use when accessing the notifyURL with the specified username.
    - `notifyURL` string — The URL to which the notifications are to be sent.
    - `notifyUsername` string — The username to use when accessing the notifyURL.
    - `sslProtocol` 'TLSv12' | 'TLSv13' — The SSL protocol employed by the endpoint. >Permitted values: `TLSv12`, `TLSv13`.

## Response `200`

OK - the request has succeeded.

- GetNotificationConfigurationResponse
  - `configurationDetails` NotificationConfigurationDetails, required
    - `active` boolean — Indicates whether the notification subscription is active.
    - `apiVersion` integer — The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.
    - `description` string — A description of the notification subscription configuration.
    - `eventConfigs` NotificationEventConfiguration[] — Contains objects that define event types and their subscription settings.
      - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_FUNDS_BELOW_THRESHOLD' | 'ACCOUNT_HOLDER_CREATED' | 'ACCOUNT_HOLDER_LIMIT_REACHED' | 'ACCOUNT_HOLDER_MIGRATED' | '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' | 'FUNDS_MIGRATED' | 'PAYMENT_FAILURE' | 'PENDING_CREDIT' | 'REFUND_FUNDS_TRANSFER' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'SCORE_SIGNAL_TRIGGERED' | 'TRANSFER_FUNDS' | 'TRANSFER_NOT_PAIDOUT_TRANSFERS', required — The type of event. Possible values: **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**.
      - `includeMode` 'EXCLUDE' | 'INCLUDE', required — Indicates whether the specified `eventType` is sent to your webhook endpoint. Possible values: * **INCLUDE**: Send the specified `eventType`. * **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **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 — Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).
    - `notifyPassword` string — The password to use when accessing the notifyURL with the specified username.
    - `notifyURL` string — The URL to which the notifications are to be sent.
    - `notifyUsername` string — The username to use when accessing the notifyURL.
    - `sslProtocol` 'TLSv12' | 'TLSv13' — The SSL protocol employed by the endpoint. >Permitted values: `TLSv12`, `TLSv13`.
  - `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' | 'balanceAccount' | 'balanceAccountActive' | 'balanceAccountCode' | 'balanceAccountId' | 'bankAccount' | 'bankAccountCode' | 'bankAccountName' | 'bankAccountUUID' | 'bankBicSwift' | 'bankCity' | 'bankCode' | 'bankName' | 'bankStatement' | 'branchCode' | 'businessContact' | 'cardToken' | 'checkCode' | 'city' | 'companyRegistration' | 'constitutionalDocument' | 'controller' | 'country' | 'countryCode' | 'currency' | 'currencyCode' | 'dateOfBirth' | 'description' | 'destinationAccountCode' | 'document' | 'documentContent' | 'documentExpirationDate' | 'documentIssuerCountry' | 'documentIssuerState' | 'documentName' | 'documentNumber' | 'documentType' | 'doingBusinessAs' | 'drivingLicence' | 'drivingLicenceBack' | 'drivingLicenceFront' | 'drivingLicense' | 'email' | 'firstName' | 'formType' | 'fullPhoneNumber' | 'gender' | 'hopWebserviceUser' | 'houseNumberOrName' | 'iban' | 'idCard' | 'idCardBack' | 'idCardFront' | 'idNumber' | 'identityDocument' | 'individualDetails' | 'infix' | 'jobTitle' | 'lastName' | 'lastReviewDate' | 'legalArrangement' | 'legalArrangementCode' | 'legalArrangementEntity' | 'legalArrangementEntityCode' | 'legalArrangementLegalForm' | 'legalArrangementMember' | 'legalArrangementMembers' | 'legalArrangementName' | 'legalArrangementReference' | 'legalArrangementRegistrationNumber' | 'legalArrangementTaxNumber' | 'legalArrangementType' | 'legalBusinessName' | 'legalEntity' | 'legalEntityType' | 'linkedViasVirtualAccount' | 'logo' | 'merchantAccount' | 'merchantCategoryCode' | 'merchantHouseNumber' | 'merchantReference' | 'microDeposit' | 'name' | 'nationality' | 'originalReference' | 'ownerCity' | 'ownerCountryCode' | 'ownerDateOfBirth' | 'ownerHouseNumberOrName' | 'ownerName' | 'ownerPostalCode' | 'ownerState' | 'ownerStreet' | 'passport' | 'passportNumber' | 'payoutMethod' | 'payoutMethodCode' | 'payoutSchedule' | 'pciSelfAssessment' | 'personalData' | 'phoneCountryCode' | 'phoneNumber' | 'postalCode' | 'primaryCurrency' | 'reason' | 'registrationNumber' | 'returnUrl' | 'schedule' | 'shareholder' | 'shareholderCode' | 'shareholderCodeAndSignatoryCode' | 'shareholderCodeOrSignatoryCode' | 'shareholderType' | 'shareholderTypes' | 'shopperInteraction' | 'signatory' | 'signatoryCode' | 'socialSecurityNumber' | 'sourceAccountCode' | 'splitAccount' | 'splitConfigurationUUID' | 'splitCurrency' | 'splitValue' | 'splits' | 'stateOrProvince' | 'status' | 'stockExchange' | 'stockNumber' | 'stockTicker' | 'store' | 'storeDetail' | 'storeName' | 'storeReference' | 'street' | 'taxId' | 'tier' | 'tierNumber' | 'transferCode' | 'ultimateParentCompany' | 'ultimateParentCompanyAddressDetails' | 'ultimateParentCompanyAddressDetailsCountry' | 'ultimateParentCompanyBusinessDetails' | 'ultimateParentCompanyBusinessDetailsLegalBusinessName' | 'ultimateParentCompanyBusinessDetailsRegistrationNumber' | 'ultimateParentCompanyCode' | 'ultimateParentCompanyStockExchange' | 'ultimateParentCompanyStockNumber' | 'ultimateParentCompanyStockNumberOrStockTicker' | 'ultimateParentCompanyStockTicker' | '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

- **2024-03-04** (v6) `7a27de1c4df5` — 1 warning
  - added the new `linkedViasVirtualAccount` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200`
- **2023-06-08** (v6) `d38e120549fe` — 1 warning
  - added the new `payoutMethod` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200`
- **2023-03-22** (v6) `fe63ed272c5e` — 15 breaking, 3 warning, 3 info
  - the request's body type/format changed from ``/`` to `object`/``
  - the `configurationDetails` request property type/format changed from ``/`` to `object`/``
  - the `configurationDetails/eventConfigs/items/` request property type/format changed from ``/`` to `object`/``
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - …17 more
- **2022-10-06** (v6) `8c095a0d5c51` — 6 breaking, 2 warning, 8 info
  - removed the enum value `SSL` of the request property `configurationDetails/sslProtocol`
  - removed the enum value `SSLInsecureCiphers` of the request property `configurationDetails/sslProtocol`
  - removed the enum value `TLS` of the request property `configurationDetails/sslProtocol`
  - removed the enum value `TLSv10` of the request property `configurationDetails/sslProtocol`
  - …12 more
- …earlier changes not shown

[Full history](https://skmtc.dev/adyen/apis/notificationconfigurationservice/changes/updateNotificationConfiguration/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/ba5cea111476/schema)