---
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**.
    - `messageFormat` 'JSON' | 'SOAP' — The data format of the notification to be sent. >Permitted values: `JSON`, `SOAP`.
    - `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.
    - `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 — The reference of a request. Can be used to uniquely identify the request.
  - `resultCode` string — The result code.
  - `submittedAsync` boolean — Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied: * **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received. * **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

## 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-08-07** (v1) `c8ceb47d7b76` — 1 info
  - api tag `General` added
- **2021-07-09** (v1) `4184946e3e8d` — 2 info
  - the endpoint scheme security `ApiKeyAuth` was added to the API
  - the endpoint scheme security `BasicAuth` was added to the API
- **2021-04-24** (v1) `64ced2e58234` — 1 warning
  - added the new `TRANSFER_NOT_PAIDOUT_TRANSFERS` enum value to the `configurationDetails/eventConfigs/items/eventType` response property for the response status `200`
- **2021-04-10** (v1) `fa01a51bf28a` — 5 info
  - added the optional property `status` to the response with the `400` status
  - added the optional property `status` to the response with the `401` status
  - added the optional property `status` to the response with the `403` status
  - added the optional property `status` to the response with the `422` status
  - …1 more
- **2021-03-26** (v1) `988c95b5257a` — 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

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