diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 1cb1a5f..eecae89 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -2412,10 +2412,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -2660,7 +2662,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -2897,7 +2899,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index cb50fbe..725f4ea 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -2761,10 +2761,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3019,7 +3021,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3266,7 +3268,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index d1486e2..79b40f0 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3488,10 +3489,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3769,7 +3772,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4049,7 +4052,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4321,7 +4324,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5156,12 +5159,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5327,6 +5336,15 @@ "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" diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index 64926d9..3d868ef 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3508,10 +3509,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3789,7 +3792,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4069,7 +4072,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4341,7 +4344,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5189,12 +5192,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5365,6 +5374,15 @@ "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" diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 146aee7..a9d4da3 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3508,10 +3509,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3789,7 +3792,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4069,7 +4072,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4341,7 +4344,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5189,12 +5192,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5385,6 +5394,15 @@ "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" diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index b0f222d..21eb3a0 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3518,10 +3519,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3799,7 +3802,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4085,7 +4088,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4363,7 +4366,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5217,12 +5220,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5416,6 +5425,15 @@ "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" diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index d672b9c..fccf87c 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3662,10 +3663,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3949,7 +3952,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4241,7 +4244,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4525,7 +4528,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5379,12 +5382,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5607,6 +5616,15 @@ "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" diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index 8575bed..0f503cd 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3662,10 +3663,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -3958,7 +3961,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4250,7 +4253,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4534,7 +4537,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5388,12 +5391,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5616,6 +5625,15 @@ "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" diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 0efb09d..c72c3e1 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3747,10 +3748,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -4053,7 +4056,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4345,7 +4348,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4629,7 +4632,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5483,12 +5486,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5736,6 +5745,15 @@ "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" diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index 498aa3f..d00d557 100644 --- a/json/PaymentService-v67.json +++ b/json/PaymentService-v67.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3747,10 +3748,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -4047,7 +4050,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4333,7 +4336,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4611,7 +4614,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5457,12 +5460,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -5710,6 +5719,15 @@ "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" diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index 4d0b554..8663c49 100644 --- a/json/PaymentService-v68.json +++ b/json/PaymentService-v68.json @@ -858,6 +858,7 @@ ], "summary" : "Create a donation", "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\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 [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "deprecated" : true, "x-addedInVersion" : "40", "operationId" : "post-donate", "x-sortIndex" : 6, @@ -3936,10 +3937,12 @@ "properties" : { "firstName" : { "description" : "The first name.", + "maxLength" : 80, "type" : "string" }, "lastName" : { "description" : "The last name.", + "maxLength" : 80, "type" : "string" } }, @@ -4249,7 +4252,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4543,7 +4546,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4829,7 +4832,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in:\n\n* [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5721,12 +5724,18 @@ "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**.", "enum" : [ + "AcquiringFees", + "AdyenCommission", + "AdyenFees", + "AdyenMarkup", "BalanceAccount", "Commission", "Default", + "Interchange", "MarketPlace", "PaymentFee", "Remainder", + "SchemeFee", "Surcharge", "Tip", "VAT" @@ -6030,6 +6039,15 @@ "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/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index b219372..e9b6e47 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -2742,9 +2742,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -3041,15 +3043,12 @@ components: type: string store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -3337,15 +3336,12 @@ components: type: string store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 806c4da..6789ec0 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -2990,9 +2990,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -3307,15 +3309,12 @@ components: type: string store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -3621,15 +3620,12 @@ components: type: string store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 33d1d60..d06c31f 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3653,9 +3654,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -3997,15 +4000,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4348,15 +4348,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4692,15 +4689,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5755,12 +5749,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -5904,6 +5904,21 @@ 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. diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index b22c6df..a59399d 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3673,9 +3674,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4017,15 +4020,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4368,15 +4368,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4712,15 +4709,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5788,12 +5782,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -5942,6 +5942,21 @@ 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. diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 1d6e2d9..3f0c803 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3673,9 +3674,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4017,15 +4020,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4368,15 +4368,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4712,15 +4709,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5788,12 +5782,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -5973,6 +5973,21 @@ 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. diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index 00d2276..513d2b4 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3690,9 +3691,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4034,15 +4037,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4391,15 +4391,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4741,15 +4738,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5823,12 +5817,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -6011,6 +6011,21 @@ 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. diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index a9155da..cd666dc 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3780,9 +3781,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4130,15 +4133,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4493,15 +4493,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4849,15 +4846,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5931,12 +5925,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -6141,6 +6141,21 @@ 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. diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index bea1b1c..c1705e0 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3780,9 +3781,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4139,15 +4142,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4502,15 +4502,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4858,15 +4855,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5940,12 +5934,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -6150,6 +6150,21 @@ 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. diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index c6d7299..a055749 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3868,9 +3869,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4235,15 +4238,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4598,15 +4598,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4954,15 +4951,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -6036,12 +6030,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -6281,6 +6281,21 @@ 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. diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml index 380f600..e7cd23d 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -3868,9 +3869,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4229,15 +4232,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4586,15 +4586,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4936,15 +4933,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -6011,12 +6005,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -6256,6 +6256,21 @@ 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. diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml index a71c11d..b192257 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -616,6 +616,7 @@ paths: If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.' + deprecated: true x-addedInVersion: '40' operationId: post-donate x-sortIndex: 6 @@ -4065,9 +4066,11 @@ components: properties: firstName: description: The first name. + maxLength: 80 type: string lastName: description: The last name. + maxLength: 80 type: string required: - firstName @@ -4442,15 +4445,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -4811,15 +4811,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -5173,15 +5170,12 @@ components: type: array store: x-addedInVersion: '23' - description: 'The ecommerce or point-of-sale store that is processing the - payment. Used in: - - - * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) - for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). - - * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) - for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).' + 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. maxLength: 16 minLength: 1 type: string @@ -6293,12 +6287,18 @@ components: **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: + - AcquiringFees + - AdyenCommission + - AdyenFees + - AdyenMarkup - BalanceAccount - Commission - Default + - Interchange - MarketPlace - PaymentFee - Remainder + - SchemeFee - Surcharge - Tip - VAT @@ -6592,6 +6592,21 @@ 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\