Get a list of notification subscription configurations

HTTP Responses

• 200 - OK

  The request has succeeded.

  Show more Show less

  configurations array [object]

  Details of the notification subscription configurations.

  Show children Hide children

  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 array [object]

  Contains objects that define event types and their subscription settings.

  Show children Hide children

  eventType string

  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 string

  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.

  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 string

  The SSL protocol employed by the endpoint.

  Permitted values: TLSv12, TLSv13.

  invalidFields array [object]

  Contains field validation errors that would prevent requests from being processed.

  Show children Hide children

  errorCode integer

  The validation error code.

  errorDescription string

  A description of the validation error.

  fieldType object

  The type of error field.

  Show children Hide children

  field string

  The full name of the property.

  fieldName string

  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.

• 400 - Bad Request

  A problem reading or understanding the request.

  Show more Show less

  errorCode string

  The error code mapped to the error message.

  errorType string

  The category of the error.

  message string

  A short explanation of the issue.

  pspReference string

  The PSP reference of the payment.

  status integer

  The HTTP response status.

• 401 - Unauthorized

  Authentication required.

  Show more Show less

  errorCode string

  The error code mapped to the error message.

  errorType string

  The category of the error.

  message string

  A short explanation of the issue.

  pspReference string

  The PSP reference of the payment.

  status integer

  The HTTP response status.

• 403 - Forbidden

  Insufficient permissions to process the request.

  Show more Show less

  errorCode string

  The error code mapped to the error message.

  errorType string

  The category of the error.

  message string

  A short explanation of the issue.

  pspReference string

  The PSP reference of the payment.

  status integer

  The HTTP response status.

• 422 - Unprocessable Entity

  A request validation error.

  Show more Show less

  errorCode string

  The error code mapped to the error message.

  errorType string

  The category of the error.

  message string

  A short explanation of the issue.

  pspReference string

  The PSP reference of the payment.

  status integer

  The HTTP response status.

• 500 - Internal Server Error

  The server could not process the request.

  Show more Show less

  errorCode string

  The error code mapped to the error message.

  errorType string

  The category of the error.

  message string

  A short explanation of the issue.

  pspReference string

  The PSP reference of the payment.

  status integer

  The HTTP response status.