---
title: "Retrieve an existing notification subscription configuration."
method: POST
path: "/getNotificationConfiguration"
---

# Retrieve an existing notification subscription configuration.

`POST /getNotificationConfiguration`

This endpoint is used to retrieve the details of the configuration of a notification subscription.

## Request body

- GetNotificationConfigurationRequest
  - `notificationId` integer, required — The ID of the notification subscription configuration whose details are to be retrieved.

## 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_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' | 'country' | 'countryCode' | 'currency' | 'currencyCode' | 'dateOfBirth' | 'description' | 'destinationAccountCode' | 'document' | 'documentExpirationDate' | 'documentIssuerCountry' | 'documentIssuerState' | 'documentName' | 'documentNumber' | 'documentType' | 'doingBusinessAs' | 'drivingLicence' | 'drivingLicenceBack' | 'drivingLicense' | 'email' | 'firstName' | 'fullPhoneNumber' | 'gender' | 'hopWebserviceUser' | 'houseNumberOrName' | 'iban' | 'idCard' | 'idCardBack' | 'idCardFront' | 'idNumber' | 'identityDocument' | 'individualDetails' | 'lastName' | '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' | 'socialSecurityNumber' | 'sourceAccountCode' | 'stateOrProvince' | 'status' | 'stockExchange' | 'stockNumber' | 'stockTicker' | 'store' | 'storeDetail' | 'storeName' | 'storeReference' | 'street' | 'taxId' | 'tier' | 'tierNumber' | 'transferCode' | 'unknown' | 'value' | 'virtualAccount' | 'visaNumber' | 'webAddress' — 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.

---

[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/b9f0690af30e/schema)