spec release

2026-03-10 08:01:24 +00:00 · 2022-10-06 14:03:14 +00:00
parent 3d5176d521
commit 49d15b16e9
34 changed files with 1131 additions and 1037 deletions
--- a/yaml/MarketPayNotificationService-v4.yaml
+++ b/yaml/MarketPayNotificationService-v4.yaml
@@ -2,14 +2,14 @@ openapi: 3.1.0
 info:
  version: '4'
  x-publicVersion: true
-  title: 'Adyen for Platforms: Notifications'
-  description: 'The Notification API sends notifications to the endpoints specified
-    in a given subscription. Subscriptions are managed through the Notification Configuration
-    API. The API specifications listed here detail the format of each notification.
-
-
-    For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).'
-  x-timestamp: '2022-08-16T10:21:11Z'
+  title: Classic Platforms - Notifications
+  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 Notification API sends notifications to the endpoints specified\
+    \ in a given subscription. \nSubscriptions are managed through the Notification\
+    \ Configuration API. The API specifications listed here detail the format of each\
+    \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications)."
+  x-timestamp: '2022-09-27T19:26:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
@@ -459,7 +459,7 @@ webhooks:
      tags:
      - Other
      summary: Booking for a capture or refund failed
-      description: Adyen sends this notification when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information)
+      description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information)
        booking for a capture or refund fails. When a booking fails due to an invalid
        account status or an unknown `accountCode`, the funds are credited or debited
        to or fromyour platform's liable account instead of the account specified
@@ -682,7 +682,7 @@ components:

            >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.

-            For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).'
+            For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
          enum:
          - InactivateAccount
          - RefundNotPaidOutTransfers
@@ -791,8 +791,8 @@ components:
          $ref: '#/components/schemas/ViasAddress'
        bankAccountDetails:
          description: Array of bank accounts associated with the account holder.
-            For details about the required `BankAccountDetail` fields, refer to [Bank
-            account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check).
+            For details about the required `bankAccountDetail` fields, see [Required
+            information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
          items:
            $ref: '#/components/schemas/BankAccountDetail'
          type: array
@@ -1320,8 +1320,8 @@ components:
        accountNumber:
          description: 'The bank account number (without separators).

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        accountType:
          description: 'The type of bank account.
@@ -1331,8 +1331,8 @@ components:
            The permitted values are: `checking`, `savings`.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        bankAccountName:
          description: The name of the bank account.
@@ -1364,31 +1364,31 @@ components:
        bankBicSwift:
          description: 'The bank identifier code.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        bankCity:
          description: 'The city in which the bank branch is located.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        bankCode:
          description: 'The bank code of the banking institution with which the bank
            account is registered.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        bankName:
          description: 'The name of the banking institution with which the bank account
            is held.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        branchCode:
          description: 'The branch code of the branch under which the bank account
@@ -1401,15 +1401,15 @@ components:

            * Germany - Bankleitzahl

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        checkCode:
          description: 'The check code of the bank account.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        countryCode:
          description: 'The two-letter country code in which the bank account is registered.
@@ -1417,17 +1417,15 @@ components:
            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        currencyCode:
          description: 'The currency in which the bank account deals.

            >The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').

-
-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            '
          type: string
        iban:
          description: 'The international bank account number.
@@ -1435,14 +1433,14 @@ components:
            >The IBAN standard is defined in ISO-13616.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerCity:
          description: 'The city of residence of the bank account owner.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerCountryCode:
          description: 'The country code of the country of residence of the bank account
@@ -1451,8 +1449,8 @@ components:
            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerDateOfBirth:
          deprecated: true
@@ -1464,14 +1462,14 @@ components:
          description: 'The house name or number of the residence of the bank account
            owner.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerName:
          description: 'The name of the bank account owner.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerNationality:
          description: 'The country code of the country of nationality of the bank
@@ -1480,26 +1478,26 @@ components:
            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerPostalCode:
          description: 'The postal code of the residence of the bank account owner.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerState:
          description: 'The state of residence of the bank account owner.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        ownerStreet:
          description: 'The street name of the residence of the bank account owner.

-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        primaryAccount:
          description: If set to true, the bank account is a primary account.
@@ -1508,8 +1506,8 @@ components:
          description: 'The tax ID number.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
        urlForVerification:
          description: 'The URL to be used for bank account verification.
@@ -1517,8 +1515,8 @@ components:
            This may be generated on bank account creation.


-            >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification)
-            section for details on field requirements.'
+            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information)
+            for details on field requirements.'
          type: string
    BeneficiarySetupNotification:
      properties:
@@ -1609,7 +1607,7 @@ components:
        shareholders:
          description: Array containing information about individuals associated with
            the account holder either through ownership or control. For details about
-            how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).
+            how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
          items:
            $ref: '#/components/schemas/ShareholderContact'
          type: array
@@ -2559,8 +2557,7 @@ components:


            >**If, during an Account Holder create request, a UUID is provided, the
-            creation of the Shareholder will fail while the creation of the Account
-            Holder will continue.**
+            creation of Account Holder will fail with a validation Error..**


            >**If, during an Account Holder update request, a UUID that is not correlated
@@ -2771,6 +2768,8 @@ components:
            `ManualCorrected`.'
          enum:
          - BalanceNotPaidOutTransfer
+          - BalancePlatformSweep
+          - BalancePlatfromSweepReturned
          - Chargeback
          - ChargebackCorrection
          - ChargebackCorrectionReceived