From d527f5af2c9f605ac366bdec212c97bf23e5ed6b Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Thu, 21 Mar 2024 15:25:49 +0100 Subject: [PATCH] spec release --- json/CheckoutService-v40.json | 18 ---- json/CheckoutService-v41.json | 18 ---- json/CheckoutService-v46.json | 18 ---- json/CheckoutService-v49.json | 18 ---- json/CheckoutService-v50.json | 18 ---- json/CheckoutService-v51.json | 18 ---- json/CheckoutService-v52.json | 18 ---- json/CheckoutService-v53.json | 18 ---- json/CheckoutService-v64.json | 18 ---- json/CheckoutService-v65.json | 18 ---- json/CheckoutService-v66.json | 18 ---- json/CheckoutService-v67.json | 18 ---- json/CheckoutService-v68.json | 18 ---- json/CheckoutService-v69.json | 18 ---- json/CheckoutService-v70.json | 18 ---- json/CheckoutService-v71.json | 18 ---- json/PaymentService-v25.json | 6 +- json/PaymentService-v30.json | 6 +- json/PaymentService-v40.json | 43 ++++------ json/PaymentService-v46.json | 43 ++++------ json/PaymentService-v49.json | 43 ++++------ json/PaymentService-v50.json | 43 ++++------ json/PaymentService-v51.json | 43 ++++------ json/PaymentService-v52.json | 43 ++++------ json/PaymentService-v64.json | 43 ++++------ json/PaymentService-v67.json | 43 ++++------ json/PaymentService-v68.json | 61 ++++++-------- yaml/CheckoutService-v40.yaml | 30 ------- yaml/CheckoutService-v41.yaml | 30 ------- yaml/CheckoutService-v46.yaml | 30 ------- yaml/CheckoutService-v49.yaml | 30 ------- yaml/CheckoutService-v50.yaml | 30 ------- yaml/CheckoutService-v51.yaml | 30 ------- yaml/CheckoutService-v52.yaml | 30 ------- yaml/CheckoutService-v53.yaml | 30 ------- yaml/CheckoutService-v64.yaml | 30 ------- yaml/CheckoutService-v65.yaml | 30 ------- yaml/CheckoutService-v66.yaml | 30 ------- yaml/CheckoutService-v67.yaml | 30 ------- yaml/CheckoutService-v68.yaml | 30 ------- yaml/CheckoutService-v69.yaml | 30 ------- yaml/CheckoutService-v70.yaml | 30 ------- yaml/CheckoutService-v71.yaml | 30 ------- yaml/PaymentService-v25.yaml | 20 ++--- yaml/PaymentService-v30.yaml | 20 ++--- yaml/PaymentService-v40.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v46.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v49.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v50.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v51.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v52.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v64.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v67.yaml | 133 +++++++++++++++--------------- yaml/PaymentService-v68.yaml | 151 +++++++++++++++++----------------- 54 files changed, 780 insertions(+), 1660 deletions(-) diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 283868a..77bdf0c 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -10883,15 +10883,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -10975,15 +10966,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index f29b240..7bfb953 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -10906,15 +10906,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -10998,15 +10989,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 960ecfc..209a6df 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -10914,15 +10914,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11006,15 +10997,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 2281a27..7d64f86 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -11652,15 +11652,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11769,15 +11760,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index e76f578..f0599c8 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -11705,15 +11705,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11837,15 +11828,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index d624c2c..7c20424 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -11742,15 +11742,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11874,15 +11865,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 0557b3e..4077d78 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -11760,15 +11760,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11892,15 +11883,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index 8276e85..d2db294 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -11784,15 +11784,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11916,15 +11907,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index 5421c31..d4198ac 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -11853,15 +11853,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11985,15 +11976,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index e3afa4b..7d1a838 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -11831,15 +11831,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11963,15 +11954,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index cd30498..1002db0 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -11841,15 +11841,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11973,15 +11964,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index c50aff9..e92353b 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -11751,15 +11751,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -11883,15 +11874,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.", "type" : "string" diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index 461b448..8bbd945 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -13197,15 +13197,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", @@ -13445,15 +13436,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index 0a7beba..0d1aa81 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -13436,15 +13436,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", @@ -13684,15 +13675,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index f3bb18d..c13c772 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -13757,15 +13757,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", @@ -14005,15 +13996,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", diff --git a/json/CheckoutService-v71.json b/json/CheckoutService-v71.json index f6a923c..c66f81a 100644 --- a/json/CheckoutService-v71.json +++ b/json/CheckoutService-v71.json @@ -13593,15 +13593,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", @@ -13841,15 +13832,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 9a99798..e43bdfb 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -387,7 +387,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2694,7 +2694,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -2932,7 +2932,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index b523579..5931803 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -504,7 +504,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -3054,7 +3054,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3302,7 +3302,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 0868e26..5ed56a6 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2590,7 +2590,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2946,7 +2946,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3052,7 +3052,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3805,7 +3805,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3813,7 +3813,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4086,7 +4086,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4094,7 +4094,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4359,7 +4359,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4367,7 +4367,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4633,7 +4633,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5200,11 +5200,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5212,11 +5212,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5341,7 +5341,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5398,15 +5398,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -5663,7 +5654,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index aad7504..32824c4 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2595,7 +2595,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2961,7 +2961,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3072,7 +3072,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3825,7 +3825,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3833,7 +3833,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4106,7 +4106,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4114,7 +4114,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4379,7 +4379,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4387,7 +4387,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4658,7 +4658,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5233,11 +5233,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5245,11 +5245,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5379,7 +5379,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5436,15 +5436,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -5706,7 +5697,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 0cf94b0..bf161e7 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2595,7 +2595,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2961,7 +2961,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3072,7 +3072,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3825,7 +3825,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3833,7 +3833,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4106,7 +4106,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4114,7 +4114,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4379,7 +4379,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4387,7 +4387,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4658,7 +4658,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5233,11 +5233,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5245,11 +5245,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5379,7 +5379,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5456,15 +5456,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -5741,7 +5732,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 6cc9bf5..15182a1 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2605,7 +2605,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2971,7 +2971,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3082,7 +3082,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3835,7 +3835,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3843,7 +3843,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4122,7 +4122,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4130,7 +4130,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4401,7 +4401,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4409,7 +4409,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4686,7 +4686,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5261,11 +5261,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5273,11 +5273,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5407,7 +5407,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5487,15 +5487,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -5789,7 +5780,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index e629376..ce81435 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2719,7 +2719,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3117,7 +3117,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3228,7 +3228,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3987,7 +3987,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3995,7 +3995,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4280,7 +4280,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4288,7 +4288,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4565,7 +4565,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4573,7 +4573,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4850,7 +4850,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5425,11 +5425,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5437,11 +5437,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5571,7 +5571,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5681,15 +5681,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -5983,7 +5974,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index d3b3257..8174066 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2719,7 +2719,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3117,7 +3117,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3228,7 +3228,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3996,7 +3996,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4004,7 +4004,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4289,7 +4289,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4297,7 +4297,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4574,7 +4574,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4582,7 +4582,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4859,7 +4859,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5434,11 +5434,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5446,11 +5446,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5580,7 +5580,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5690,15 +5690,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -5992,7 +5983,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 2b13eae..34f301d 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2719,7 +2719,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3117,7 +3117,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3228,7 +3228,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4093,7 +4093,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4101,7 +4101,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4386,7 +4386,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4394,7 +4394,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4671,7 +4671,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4679,7 +4679,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4956,7 +4956,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5531,11 +5531,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5543,11 +5543,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5703,7 +5703,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5813,15 +5813,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -6115,7 +6106,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index 6a28881..648edfa 100644 --- a/json/PaymentService-v67.json +++ b/json/PaymentService-v67.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2719,7 +2719,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3117,7 +3117,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3228,7 +3228,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4087,7 +4087,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4095,7 +4095,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4374,7 +4374,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4382,7 +4382,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4653,7 +4653,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4661,7 +4661,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4938,7 +4938,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5505,11 +5505,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5517,11 +5517,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5677,7 +5677,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5787,15 +5787,6 @@ "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "sdkAppID" : { "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", "type" : "string" @@ -6143,7 +6134,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index 5e27e9f..ff93b1b 100644 --- a/json/PaymentService-v68.json +++ b/json/PaymentService-v68.json @@ -621,7 +621,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-sortIndex" : 4, "x-methodName" : "cancelOrRefund", @@ -2851,7 +2851,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -2860,7 +2860,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3155,7 +3155,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -3259,7 +3259,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -3268,7 +3268,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3375,7 +3375,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -3384,7 +3384,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3527,7 +3527,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -4214,7 +4214,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "recurring" : { @@ -4290,7 +4290,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4298,7 +4298,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4585,7 +4585,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4593,7 +4593,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4872,7 +4872,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4880,7 +4880,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", + "description" : "Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5196,7 +5196,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -5205,7 +5205,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5772,11 +5772,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -5784,11 +5784,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", @@ -5940,7 +5940,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -5949,7 +5949,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -6110,15 +6110,6 @@ "description" : "Indicates the type of payment for which an authentication is requested (message extension)", "type" : "string" }, - "platform" : { - "description" : "The platform of the shopper.\nAllowed values:\n* `iOS`\n* `android`\n* `browser`", - "enum" : [ - "iOS", - "android", - "browser" - ], - "type" : "string" - }, "purchaseInstalData" : { "x-addedInVersion" : "68", "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", @@ -6610,7 +6601,7 @@ }, "platformChargebackLogic" : { "x-addedInVersion" : "68", - "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).", + "description" : "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model).", "$ref" : "#/components/schemas/PlatformChargebackLogic" }, "reference" : { @@ -6619,7 +6610,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 04edc6e..d2bc4f7 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -10689,21 +10689,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -10808,21 +10793,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index bc22b21..e02742e 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -10706,21 +10706,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -10825,21 +10810,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index a83d4de..5a0db73 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -10714,21 +10714,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -10833,21 +10818,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index cddc524..f7f61d9 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -11349,21 +11349,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11504,21 +11489,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index d318b62..d169d3f 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -11407,21 +11407,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11575,21 +11560,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 99bef71..02460ee 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -11443,21 +11443,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11611,21 +11596,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 7abfc76..ce8040c 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -11459,21 +11459,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11627,21 +11612,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index a22530d..170aa25 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -11479,21 +11479,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11647,21 +11632,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 6b8b0e0..d836582 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -11557,21 +11557,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11725,21 +11710,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 687f5a8..60f9218 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -11538,21 +11538,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11706,21 +11691,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 5e52462..693b036 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -11546,21 +11546,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11714,21 +11699,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index 7100ea4..17fc81d 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -11490,21 +11490,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -11658,21 +11643,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: The `sdkAppID` value as received from the 3D Secure 2 SDK. type: string diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index 444ab98..108afe0 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -12983,21 +12983,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ @@ -13269,21 +13254,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 87dca20..295edd4 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -13228,21 +13228,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ @@ -13514,21 +13499,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index 69bbd80..4442e76 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -13533,21 +13533,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ @@ -13819,21 +13804,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ diff --git a/yaml/CheckoutService-v71.yaml b/yaml/CheckoutService-v71.yaml index 006cd1b..990edbe 100644 --- a/yaml/CheckoutService-v71.yaml +++ b/yaml/CheckoutService-v71.yaml @@ -13345,21 +13345,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ @@ -13631,21 +13616,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index f20a5fc..99bb9a4 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -278,7 +278,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -3075,11 +3075,10 @@ components: type: string store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -3369,11 +3368,10 @@ components: type: string store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index e1bf1cf..74a2b65 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -363,7 +363,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -3342,11 +3342,10 @@ components: type: string store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -3654,11 +3653,10 @@ components: type: string store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index dd2f410..699e240 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2833,8 +2833,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3133,8 +3133,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3215,8 +3215,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4034,18 +4034,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4383,18 +4383,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4725,18 +4725,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5004,8 +5004,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5761,11 +5761,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -5773,21 +5773,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -5795,18 +5796,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -5895,8 +5907,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5966,21 +5978,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6213,8 +6210,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index f07e53f..8608ac9 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2838,8 +2838,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3148,8 +3148,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3235,8 +3235,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4054,18 +4054,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4403,18 +4403,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4745,18 +4745,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5029,8 +5029,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5794,11 +5794,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -5806,21 +5806,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -5828,18 +5829,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -5933,8 +5945,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6004,21 +6016,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6256,8 +6253,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 42efb2d..8d7f2a4 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2838,8 +2838,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3148,8 +3148,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3235,8 +3235,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4054,18 +4054,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4403,18 +4403,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4745,18 +4745,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5029,8 +5029,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5794,11 +5794,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -5806,21 +5806,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -5828,18 +5829,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -5933,8 +5945,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6035,21 +6047,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6300,8 +6297,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index e611388..f7f31a4 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2855,8 +2855,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3165,8 +3165,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3252,8 +3252,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4071,18 +4071,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4426,18 +4426,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4774,18 +4774,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5064,8 +5064,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5829,11 +5829,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -5841,21 +5841,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -5863,18 +5864,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -5968,8 +5980,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6073,21 +6085,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6353,8 +6350,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 84d2da5..5bfde01 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2923,8 +2923,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3257,8 +3257,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3344,8 +3344,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4169,18 +4169,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4530,18 +4530,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4884,18 +4884,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5174,8 +5174,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5939,11 +5939,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -5951,21 +5951,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -5973,18 +5974,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -6078,8 +6090,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6206,21 +6218,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6486,8 +6483,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 9f08cf0..c971128 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2923,8 +2923,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3257,8 +3257,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3344,8 +3344,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4178,18 +4178,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4539,18 +4539,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4893,18 +4893,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5183,8 +5183,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -5948,11 +5948,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -5960,21 +5960,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -5982,18 +5983,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -6087,8 +6099,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6215,21 +6227,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6495,8 +6492,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index aa13fe0..4d3e41d 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2923,8 +2923,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3257,8 +3257,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3344,8 +3344,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4276,18 +4276,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4637,18 +4637,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4991,18 +4991,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5281,8 +5281,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6046,11 +6046,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -6058,21 +6058,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -6080,18 +6081,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -6221,8 +6233,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6349,21 +6361,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6629,8 +6626,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml index e7be714..0e441f6 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2923,8 +2923,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3257,8 +3257,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3344,8 +3344,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -4270,18 +4270,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4625,18 +4625,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4973,18 +4973,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5263,8 +5263,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6021,11 +6021,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -6033,21 +6033,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -6055,18 +6056,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -6196,8 +6208,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6324,21 +6336,6 @@ components: you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string sdkAppID: description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. @@ -6669,8 +6666,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml index ac67076..9c924b8 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -440,7 +440,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -3065,7 +3065,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -3076,8 +3076,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3329,7 +3329,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -3407,7 +3407,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -3418,8 +3418,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3498,7 +3498,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -3509,8 +3509,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -3675,7 +3675,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -4355,7 +4355,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' recurring: description: The recurring settings for the payment. Use this property when @@ -4484,18 +4484,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -4851,18 +4851,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5211,18 +5211,18 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) + or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone + [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' - description: Required for Adyen for Platforms integrations if you have a - platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) - (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) - or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) - (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) + description: Required for Adyen for Platforms integrations if you are a + platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) + (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) + (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 @@ -5537,7 +5537,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -5548,8 +5548,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6306,11 +6306,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -6318,21 +6318,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -6340,18 +6341,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission @@ -6474,7 +6486,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -6485,8 +6497,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array @@ -6663,21 +6675,6 @@ components: description: Indicates the type of payment for which an authentication is requested (message extension) type: string - platform: - description: 'The platform of the shopper. - - Allowed values: - - * `iOS` - - * `android` - - * `browser`' - enum: - - iOS - - android - - browser - type: string purchaseInstalData: x-addedInVersion: '68' description: "Indicates the maximum number of authorisations permitted for\ @@ -7164,7 +7161,7 @@ components: type: string platformChargebackLogic: x-addedInVersion: '68' - description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). + description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference @@ -7175,8 +7172,8 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split - between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + between accounts when using Adyen for Platforms. For more information, + see how to split payments for [platforms](https://docs.adyen.com/platforms/automatic-split-configuration/). items: $ref: '#/components/schemas/Split' type: array