openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute createNotificationConfiguration API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: createNotificationConfiguration paths: /createNotificationConfiguration: post: tags: - createNotificationConfiguration summary: Adyen Subscribe to Notifications description: Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured. operationId: post-createNotificationConfiguration x-groupName: General x-sortIndex: 1 x-methodName: createNotificationConfiguration security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: basic: $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: '200': content: application/json: examples: basic: $ref: '#/components/examples/post-createNotificationConfiguration-basic-200' schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-createNotificationConfiguration400Example: summary: Default post-createNotificationConfiguration 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-createNotificationConfiguration401Example: summary: Default post-createNotificationConfiguration 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-createNotificationConfiguration403Example: summary: Default post-createNotificationConfiguration 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-createNotificationConfiguration422Example: summary: Default post-createNotificationConfiguration 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-createNotificationConfiguration500Example: summary: Default post-createNotificationConfiguration 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: 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: '#/components/schemas/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 CreateNotificationConfigurationRequest: properties: configurationDetails: description: Details of the prospective notification subscription configuration. $ref: '#/components/schemas/NotificationConfigurationDetails' required: - configurationDetails type: object ServiceError: properties: errorCode: description: The error code mapped to the error message. type: string errorType: description: The category of the error. type: string message: description: A short explanation of the issue. type: string pspReference: description: The PSP reference of the payment. type: string status: description: The HTTP response status. format: int32 type: integer type: object NotificationEventConfiguration: properties: eventType: description: '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**.' 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. 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**.' enum: - EXCLUDE - INCLUDE type: string required: - eventType - includeMode 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: '#/components/schemas/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. >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).' 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. >Permitted values: `TLSv12`, `TLSv13`.' enum: - TLSv12 - TLSv13 type: string type: object GetNotificationConfigurationResponse: properties: configurationDetails: description: Details of the notification subscription configuration. $ref: '#/components/schemas/NotificationConfigurationDetails' invalidFields: x-addedInVersion: '5' description: Contains field validation errors that would prevent requests from being processed. items: $ref: '#/components/schemas/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 examples: post-createNotificationConfiguration-basic-200: summary: Example response for request 'basic' value: pspReference: '8516178952380553' configurationDetails: active: true description: Unique description 123 eventConfigs: - eventType: ACCOUNT_HOLDER_VERIFICATION includeMode: INCLUDE notificationId: 28468 notifyURL: https://www.adyen.com/notification-handler sslProtocol: TLSv13 post-createNotificationConfiguration-basic: summary: Create a notification configuration value: configurationDetails: active: true description: Unique description 123 eventConfigs: - eventType: ACCOUNT_HOLDER_VERIFICATION includeMode: INCLUDE notifyURL: https://www.adyen.com/notification-handler notifyUsername: testUserName notifyPassword: testPassword sslProtocol: TLSv13 securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification