spec release

Adyen · Aug 30, 2024 · 963849f · 963849f
1 parent 46088ba
commit 963849f
Show file tree

Hide file tree

Showing 34 changed files with 3,739 additions and 272 deletions.
diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json
@@ -5142,7 +5142,7 @@
                   "type" : "string"
                },
                "networkPaymentReference" : {
-                  "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.",
+                  "description" : "The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.",
                   "type" : "string"
                },
                "number" : {
@@ -5302,7 +5302,7 @@
                   "type" : "string"
                },
                "networkPaymentReference" : {
-                  "description" : "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.",
+                  "description" : "The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.",
                   "type" : "string"
                },
                "number" : {
@@ -6065,7 +6065,7 @@
                   "type" : "string"
                },
                "returnUrl" : {
-                  "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value.\n> The URL must not include personally identifiable information (PII), for example name or email address.",
+                  "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`\nIf the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value.\n> The URL must not include personally identifiable information (PII), for example name or email address.",
                   "maxLength" : 8000,
                   "type" : "string"
                },
@@ -6445,18 +6445,19 @@
                   "$ref" : "#/components/schemas/Address"
                },
                "shopperEmail" : {
-                  "description" : "Email address of the person.",
+                  "description" : "The email address of the person funding the money.",
                   "type" : "string"
                },
                "shopperName" : {
-                  "description" : "The name of the person",
+                  "description" : "The name of the person funding the money.",
                   "$ref" : "#/components/schemas/Name"
                },
                "telephoneNumber" : {
-                  "description" : "Phone number of the person",
+                  "description" : "The phone number of the person funding the money.",
                   "type" : "string"
                },
                "walletIdentifier" : {
+                  "description" : "The unique identifier of the wallet where the funds are coming from.",
                   "type" : "string"
                }
             },
@@ -9146,6 +9147,13 @@
                   "minLength" : 1,
                   "type" : "string"
                },
+               "subMerchants" : {
+                  "description" : "This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator",
+                  "items" : {
+                     "$ref" : "#/components/schemas/SubMerchantInfoWrapper"
+                  },
+                  "type" : "array"
+               },
                "telephoneNumber" : {
                   "description" : "The shopper's telephone number.",
                   "type" : "string"
@@ -9549,7 +9557,7 @@
                   "type" : "string"
                },
                "returnUrl" : {
-                  "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value.\n> The URL must not include personally identifiable information (PII), for example name or email address.",
+                  "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`\nIf the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value.\n> The URL must not include personally identifiable information (PII), for example name or email address.",
                   "maxLength" : 8000,
                   "type" : "string"
                },
@@ -10997,6 +11005,61 @@
             },
             "type" : "object"
          },
+         "SubMerchantInfo" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "address" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's address.\n",
+                  "$ref" : "#/components/schemas/BillingAddress"
+               },
+               "amount" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The amount of the payment corresponding to each sub-merchant. This value will be different than the request amount if shopper is purchasing items at different sub-merchants' shops.",
+                  "$ref" : "#/components/schemas/Amount"
+               },
+               "email" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The email associated with the sub-merchant's account.",
+                  "maxLength" : 320,
+                  "type" : "string"
+               },
+               "id" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters",
+                  "type" : "string"
+               },
+               "mcc" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits",
+                  "type" : "string"
+               },
+               "name" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters",
+                  "type" : "string"
+               },
+               "phoneNumber" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The phone number associated with the sub-merchant's account.",
+                  "maxLength" : 20,
+                  "type" : "string"
+               },
+               "registeredSince" : {
+                  "type" : "string"
+               },
+               "taxId" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ",
+                  "type" : "string"
+               },
+               "url" : {
+                  "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's URL on the platform, i.e. the sub-merchant's shop.",
+                  "maxLength" : 320,
+                  "type" : "string"
+               }
+            },
+            "type" : "object"
+         },
+         "SubMerchantInfoWrapper" : {
+            "properties" : {
+               "SubMerchant" : {
+                  "$ref" : "#/components/schemas/SubMerchantInfo"
+               }
+            }
+         },
          "TaxTotal" : {
             "additionalProperties" : false,
             "properties" : {