{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-get-notification-configuration-response-schema.json", "title": "GetNotificationConfigurationResponse", "x-generated": "2026-10-12", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/adyen-createnotificationconfiguration-api-openapi.yml#/components/schemas/GetNotificationConfigurationResponse", "properties": { "configurationDetails": { "description": "Details of the notification subscription configuration.", "$ref": "#/$defs/NotificationConfigurationDetails" }, "invalidFields": { "x-addedInVersion": "5", "description": "Contains field validation errors that would prevent requests from being processed.", "items": { "$ref": "#/$defs/ErrorFieldType" }, "type": "array" }, "pspReference": { "description": "The reference of a request. Can be used to uniquely identify the request.", "type": "string" }, "resultCode": { "description": "The result code.", "type": "string" } }, "required": [ "configurationDetails" ], "type": "object", "$defs": { "ErrorFieldType": { "properties": { "errorCode": { "description": "The validation error code.", "format": "int32", "type": "integer" }, "errorDescription": { "description": "A description of the validation error.", "type": "string" }, "fieldType": { "description": "The type of error field.", "$ref": "#/$defs/FieldType" } }, "type": "object" }, "FieldType": { "properties": { "field": { "description": "The full name of the property.", "type": "string" }, "fieldName": { "description": "The type of the field.", "enum": [ "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", "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" ], "type": "string" }, "shareholderCode": { "description": "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.", "type": "string" } }, "type": "object" }, "NotificationConfigurationDetails": { "properties": { "active": { "description": "Indicates whether the notification subscription is active.", "type": "boolean" }, "apiVersion": { "description": "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.", "format": "int32", "type": "integer" }, "description": { "description": "A description of the notification subscription configuration.", "type": "string" }, "eventConfigs": { "description": "Contains objects that define event types and their subscription settings.", "items": { "$ref": "#/$defs/NotificationEventConfiguration" }, "type": "array" }, "hmacSignatureKey": { "x-addedInVersion": "5", "description": "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.\n\n>Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\").\n\nThe omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).", "type": "string" }, "notificationId": { "description": "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).", "format": "int64", "type": "integer" }, "notifyPassword": { "description": "The password to use when accessing the notifyURL with the specified username.", "type": "string" }, "notifyURL": { "description": "The URL to which the notifications are to be sent.", "type": "string" }, "notifyUsername": { "description": "The username to use when accessing the notifyURL.", "type": "string" }, "sslProtocol": { "description": "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.", "enum": [ "TLSv12", "TLSv13" ], "type": "string" } }, "type": "object" }, "NotificationEventConfiguration": { "properties": { "eventType": { "description": "The type of event.\n\nPossible 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**.", "enum": [ "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" ], "type": "string" }, "includeMode": { "description": "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum": [ "EXCLUDE", "INCLUDE" ], "type": "string" } }, "required": [ "eventType", "includeMode" ], "type": "object" } } }