--- title: "Retrieve an existing notification subscription configuration." method: POST path: "/getNotificationConfiguration" tags: ["General"] --- # 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 — 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_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' | '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, 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' | 'legalArrangementMembers' | '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' | 'payoutSchedule' | 'pciSelfAssessment' | 'personalData' | 'phoneCountryCode' | 'phoneNumber' | 'postalCode' | 'primaryCurrency' | 'reason' | 'registrationNumber' | 'returnUrl' | 'schedule' | 'shareholder' | 'shareholderCode' | 'shareholderCodeAndSignatoryCode' | 'shareholderCodeOrSignatoryCode' | 'shareholderType' | '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 - **2021-11-01** (v6) `136d4967eb35` — 1 warning - added the new `pciSelfAssessment` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - **2021-08-07** (v6) `aaaf1c57c838` — 2 warning, 1 info - added the new `payoutSchedule` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - added the new `splitConfigurationUUID` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - api tag `General` added - **2021-07-09** (v6) `5bc20906098d` — 12 warning, 2 info - added the new `legalArrangementMembers` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - added the new `ultimateParentCompany` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - added the new `ultimateParentCompanyAddressDetails` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - added the new `ultimateParentCompanyAddressDetailsCountry` enum value to the `invalidFields/items/fieldType/fieldName` response property for the response status `200` - …10 more - …earlier changes not shown [Full history](https://skmtc.dev/adyen/apis/notificationconfigurationservice/changes/getNotificationConfiguration/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/136d4967eb35/schema)