diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index cae11ff3..777546f1 100644 --- 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" : { diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index d4f39546..2c813390 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -5355,7 +5355,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" : { @@ -5515,7 +5515,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" : { @@ -6329,7 +6329,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" }, @@ -6714,18 +6714,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" } }, @@ -9504,6 +9505,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" @@ -9925,7 +9933,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" }, @@ -11421,6 +11429,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" : { diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index a29cd0e5..27579cbf 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -5368,7 +5368,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" : { @@ -5528,7 +5528,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" : { @@ -6342,7 +6342,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" }, @@ -6727,18 +6727,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" } }, @@ -9522,6 +9523,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" @@ -9948,7 +9956,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" }, @@ -11444,6 +11452,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" : { diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 735a0c58..15aceffe 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -5368,7 +5368,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" : { @@ -5528,7 +5528,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" : { @@ -6342,7 +6342,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" }, @@ -6727,18 +6727,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" } }, @@ -9522,6 +9523,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" @@ -9948,7 +9956,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" }, @@ -11452,6 +11460,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" : { diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 64c12136..fcd3bbc3 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -5431,7 +5431,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" : { @@ -5600,7 +5600,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" : { @@ -5760,6 +5760,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6775,7 +6827,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" }, @@ -7165,18 +7217,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" } }, @@ -10103,6 +10156,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10137,6 +10197,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10569,7 +10632,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" }, @@ -12179,6 +12242,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" : { diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index 3098bdab..d3208ab1 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -5453,7 +5453,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" : { @@ -5622,7 +5622,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" : { @@ -5782,6 +5782,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6797,7 +6849,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" }, @@ -7193,18 +7245,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" } }, @@ -10141,6 +10194,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10181,6 +10241,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10613,7 +10676,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" }, @@ -12229,6 +12292,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" : { diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index a28c066c..628738b8 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -5459,7 +5459,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" : { @@ -5628,7 +5628,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" : { @@ -5788,6 +5788,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6809,7 +6861,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" }, @@ -7205,18 +7257,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" } }, @@ -10172,6 +10225,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10212,6 +10272,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10650,7 +10713,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" }, @@ -12266,6 +12329,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" : { diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 640ca170..62db454c 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -5459,7 +5459,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" : { @@ -5628,7 +5628,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" : { @@ -5788,6 +5788,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6817,7 +6869,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" }, @@ -7213,18 +7265,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" } }, @@ -10185,6 +10238,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10225,6 +10285,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10668,7 +10731,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" }, @@ -12284,6 +12347,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" : { diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index e5fc5bd8..820d15a8 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -5459,7 +5459,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" : { @@ -5628,7 +5628,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" : { @@ -5788,6 +5788,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6817,7 +6869,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" }, @@ -7213,18 +7265,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" } }, @@ -10200,6 +10253,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10240,6 +10300,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10683,7 +10746,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" }, @@ -12308,6 +12371,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" : { diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index 275be7fc..a76b835e 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -5459,7 +5459,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" : { @@ -5628,7 +5628,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" : { @@ -5788,6 +5788,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6817,7 +6869,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" }, @@ -7213,18 +7265,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" } }, @@ -10255,6 +10308,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10295,6 +10355,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10752,7 +10815,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" }, @@ -12377,6 +12440,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" : { diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index cbfd18b3..03744f96 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -5473,7 +5473,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" : { @@ -5642,7 +5642,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" : { @@ -5802,6 +5802,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6825,7 +6877,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" }, @@ -7221,18 +7273,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" } }, @@ -10227,6 +10280,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10267,6 +10327,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10718,7 +10781,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" }, @@ -12355,6 +12418,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" : { diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 0be81a3e..fdeac4f5 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -5473,7 +5473,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" : { @@ -5642,7 +5642,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" : { @@ -5802,6 +5802,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -6825,7 +6877,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" }, @@ -7221,18 +7273,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" } }, @@ -10232,6 +10285,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10272,6 +10332,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10728,7 +10791,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" }, @@ -12365,6 +12428,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" : { diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index 3c7448da..9b87bf75 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -5631,7 +5631,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" : { @@ -5800,7 +5800,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" : { @@ -5960,6 +5960,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -7072,7 +7124,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" }, @@ -7468,18 +7520,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" } }, @@ -10476,6 +10529,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -10516,6 +10576,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -10935,7 +10998,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" }, @@ -12562,6 +12625,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" : { diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index 42f2cf29..620fad99 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -5988,7 +5988,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" : { @@ -6162,7 +6162,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" : { @@ -6332,6 +6332,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutNativeRedirectAction" : { "additionalProperties" : false, "properties" : { @@ -8197,7 +8249,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" }, @@ -8608,18 +8660,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" } }, @@ -11828,6 +11881,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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" @@ -11868,6 +11928,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" }, @@ -12308,7 +12371,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" }, @@ -14044,6 +14107,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" : { diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index 944292ea..80d0280f 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -6023,7 +6023,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" : { @@ -6197,7 +6197,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" : { @@ -6367,6 +6367,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutDelegatedAuthenticationAction" : { "additionalProperties" : false, "properties" : { @@ -8326,7 +8378,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" }, @@ -8733,18 +8785,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" } }, @@ -12043,6 +12096,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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/SubMerchantInfo" + }, + "type" : "array" + }, "telephoneNumber" : { "description" : "The shopper's telephone number.", "type" : "string" @@ -12086,6 +12146,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutDelegatedAuthenticationAction" }, @@ -12534,7 +12597,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" }, @@ -14283,6 +14346,54 @@ }, "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" + }, "TaxTotal" : { "additionalProperties" : false, "properties" : { diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index b6b58017..6ff015c5 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -6135,7 +6135,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" : { @@ -6309,7 +6309,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" : { @@ -6479,6 +6479,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutDelegatedAuthenticationAction" : { "additionalProperties" : false, "properties" : { @@ -8494,7 +8546,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" }, @@ -8901,18 +8953,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" } }, @@ -12329,6 +12382,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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/SubMerchantInfo" + }, + "type" : "array" + }, "telephoneNumber" : { "description" : "The shopper's telephone number.", "type" : "string" @@ -12372,6 +12432,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutDelegatedAuthenticationAction" }, @@ -12820,7 +12883,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" }, @@ -14598,25 +14661,32 @@ "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" }, @@ -14624,9 +14694,11 @@ "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" } diff --git a/json/CheckoutService-v71.json b/json/CheckoutService-v71.json index 1648f1e0..b479c575 100644 --- a/json/CheckoutService-v71.json +++ b/json/CheckoutService-v71.json @@ -6135,7 +6135,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" : { @@ -6309,7 +6309,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" : { @@ -6479,6 +6479,58 @@ ], "type" : "object" }, + "CheckoutBankTransferAction" : { + "additionalProperties" : false, + "properties" : { + "beneficiary" : { + "description" : "The name of the account holder.", + "type" : "string" + }, + "bic" : { + "description" : "The BIC of the IBAN.", + "type" : "string" + }, + "downloadUrl" : { + "description" : "The url to download payment details with.", + "type" : "string" + }, + "iban" : { + "description" : "The IBAN of the bank transfer.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "reference" : { + "description" : "The transfer reference.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", + "type" : "string" + }, + "totalAmount" : { + "description" : "The amount of the bank transfer.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the action.", + "enum" : [ + "bankTransfer" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" + }, "CheckoutDelegatedAuthenticationAction" : { "additionalProperties" : false, "properties" : { @@ -8355,7 +8407,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" }, @@ -8725,18 +8777,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" } }, @@ -12165,6 +12218,13 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).", "type" : "boolean" }, + "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/SubMerchantInfo" + }, + "type" : "array" + }, "telephoneNumber" : { "description" : "The shopper's telephone number.", "type" : "string" @@ -12208,6 +12268,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutBankTransferAction" + }, { "$ref" : "#/components/schemas/CheckoutDelegatedAuthenticationAction" }, @@ -12656,7 +12719,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" }, @@ -14434,25 +14497,32 @@ "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" }, @@ -14460,9 +14530,11 @@ "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" } diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index 90256eef..c5c4399c 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -4724,7 +4724,7 @@ components: maxLength: 15000 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) + 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: @@ -4870,7 +4870,7 @@ components: maxLength: 15000 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) + 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: @@ -5598,8 +5598,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -5962,15 +5964,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -8492,6 +8496,12 @@ components: maxLength: 64 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 @@ -8948,8 +8958,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -10624,6 +10636,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 30d87103..5c4e0013 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -4971,7 +4971,7 @@ components: maxLength: 15000 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) + 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: @@ -5117,7 +5117,7 @@ components: maxLength: 15000 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) + 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: @@ -5916,8 +5916,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6286,15 +6288,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -8933,6 +8937,12 @@ components: maxLength: 64 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 @@ -9407,8 +9417,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11107,6 +11119,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 7fcf4c00..dd71b341 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -4980,7 +4980,7 @@ components: maxLength: 15000 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) + 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: @@ -5126,7 +5126,7 @@ components: maxLength: 15000 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) + 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: @@ -5925,8 +5925,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6295,15 +6297,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -8946,6 +8950,12 @@ components: maxLength: 64 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 @@ -9424,8 +9434,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11124,6 +11136,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 52856a62..8c960a5f 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -4980,7 +4980,7 @@ components: maxLength: 15000 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) + 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: @@ -5126,7 +5126,7 @@ components: maxLength: 15000 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) + 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: @@ -5925,8 +5925,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6295,15 +6297,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -8946,6 +8950,12 @@ components: maxLength: 64 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 @@ -9424,8 +9434,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11132,6 +11144,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index d4112a64..7f22e713 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -5043,7 +5043,7 @@ components: maxLength: 15000 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) + 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: @@ -5198,7 +5198,7 @@ components: maxLength: 15000 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) + 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: @@ -5330,6 +5330,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6278,8 +6317,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6653,15 +6694,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9440,6 +9483,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9468,6 +9517,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -9946,8 +9996,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11745,6 +11797,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 90688341..b820b0f7 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -5070,7 +5070,7 @@ components: maxLength: 15000 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) + 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: @@ -5225,7 +5225,7 @@ components: maxLength: 15000 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) + 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: @@ -5357,6 +5357,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6305,8 +6344,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6686,15 +6727,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9483,6 +9526,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9517,6 +9566,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -9995,8 +10045,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11800,6 +11852,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 51168bab..7b571f74 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -5076,7 +5076,7 @@ components: maxLength: 15000 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) + 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: @@ -5231,7 +5231,7 @@ components: maxLength: 15000 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) + 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: @@ -5363,6 +5363,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6317,8 +6356,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6698,15 +6739,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9513,6 +9556,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9547,6 +9596,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10031,8 +10081,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11836,6 +11888,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 137bdaf1..8f583cb5 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -5076,7 +5076,7 @@ components: maxLength: 15000 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) + 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: @@ -5231,7 +5231,7 @@ components: maxLength: 15000 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) + 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: @@ -5363,6 +5363,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6325,8 +6364,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6706,15 +6747,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9525,6 +9568,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9559,6 +9608,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10047,8 +10097,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11852,6 +11904,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index 5d0309ee..24eb7d58 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -5076,7 +5076,7 @@ components: maxLength: 15000 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) + 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: @@ -5231,7 +5231,7 @@ components: maxLength: 15000 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) + 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: @@ -5363,6 +5363,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6325,8 +6364,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6706,15 +6747,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9538,6 +9581,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9572,6 +9621,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10060,8 +10110,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11872,6 +11924,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 1643069a..e048a70c 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -5076,7 +5076,7 @@ components: maxLength: 15000 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) + 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: @@ -5231,7 +5231,7 @@ components: maxLength: 15000 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) + 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: @@ -5363,6 +5363,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6325,8 +6364,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6706,15 +6747,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9601,6 +9644,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9635,6 +9684,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10137,8 +10187,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11949,6 +12001,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 7556ea8e..6392eecf 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -5087,7 +5087,7 @@ components: maxLength: 15000 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) + 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: @@ -5242,7 +5242,7 @@ components: maxLength: 15000 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) + 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: @@ -5374,6 +5374,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6330,8 +6369,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6711,15 +6752,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9577,6 +9620,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9611,6 +9660,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10107,8 +10157,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11930,6 +11982,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 49b90137..b1d198c6 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -5087,7 +5087,7 @@ components: maxLength: 15000 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) + 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: @@ -5242,7 +5242,7 @@ components: maxLength: 15000 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) + 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: @@ -5374,6 +5374,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6330,8 +6369,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6711,15 +6752,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9581,6 +9624,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9615,6 +9664,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10115,8 +10165,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -11938,6 +11990,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index 0f737949..24eeaf6a 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -5184,7 +5184,7 @@ components: maxLength: 15000 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) + 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: @@ -5339,7 +5339,7 @@ components: maxLength: 15000 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) + 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: @@ -5470,6 +5470,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -6499,8 +6538,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -6880,15 +6921,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -9773,6 +9816,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -9807,6 +9856,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -10275,8 +10325,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -12087,6 +12139,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index 18dd1360..0f5c470b 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -5495,7 +5495,7 @@ components: maxLength: 15000 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) + 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: @@ -5654,7 +5654,7 @@ components: maxLength: 15000 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) + 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: @@ -5793,6 +5793,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutNativeRedirectAction: additionalProperties: false properties: @@ -7697,8 +7736,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -8090,15 +8131,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -11189,6 +11232,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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 @@ -11223,6 +11272,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' @@ -11715,8 +11765,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -13636,6 +13688,72 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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: diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 056d98b8..9926a797 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -5540,7 +5540,7 @@ components: maxLength: 15000 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) + 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: @@ -5699,7 +5699,7 @@ components: maxLength: 15000 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) + 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: @@ -5838,6 +5838,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutDelegatedAuthenticationAction: additionalProperties: false properties: @@ -7825,8 +7864,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -8217,15 +8258,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -11412,6 +11455,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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/SubMerchantInfo' + type: array telephoneNumber: description: The shopper's telephone number. type: string @@ -11449,6 +11498,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' @@ -11947,8 +11997,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -13881,6 +13933,68 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object + SubMerchantInfo: + additionalProperties: false + properties: + address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' + $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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 TaxTotal: additionalProperties: false properties: diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index 6f189fb4..42cd81c2 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -5623,7 +5623,7 @@ components: maxLength: 15000 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) + 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: @@ -5782,7 +5782,7 @@ components: maxLength: 15000 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) + 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: @@ -5921,6 +5921,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutDelegatedAuthenticationAction: additionalProperties: false properties: @@ -7976,8 +8015,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -8368,15 +8409,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -11672,6 +11715,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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/SubMerchantInfo' + type: array telephoneNumber: description: The shopper's telephone number. type: string @@ -11709,6 +11758,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' @@ -12207,8 +12257,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -14184,26 +14236,61 @@ components: additionalProperties: false properties: address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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 diff --git a/yaml/CheckoutService-v71.yaml b/yaml/CheckoutService-v71.yaml index f14bde6e..f577c894 100644 --- a/yaml/CheckoutService-v71.yaml +++ b/yaml/CheckoutService-v71.yaml @@ -5623,7 +5623,7 @@ components: maxLength: 15000 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) + 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: @@ -5782,7 +5782,7 @@ components: maxLength: 15000 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) + 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: @@ -5921,6 +5921,45 @@ components: required: - type type: object + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutDelegatedAuthenticationAction: additionalProperties: false properties: @@ -7817,8 +7856,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -8166,15 +8207,17 @@ components: description: The address where to send the invoice. $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 type: object FundRecipient: @@ -11484,6 +11527,12 @@ components: description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). type: boolean + 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/SubMerchantInfo' + type: array telephoneNumber: description: The shopper's telephone number. type: string @@ -11521,6 +11570,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' - $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' @@ -12019,8 +12069,10 @@ components: * 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). - Example: `my-app://your.package.name`If the URL to return to includes - non-ASCII characters, like spaces or special letters, URL encode the value. + Example: `my-app://your.package.name` + + If the URL to return to includes non-ASCII characters, like spaces or + special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.' @@ -13996,26 +14048,61 @@ components: additionalProperties: false properties: address: + description: 'Required for transactions performed by registered payment + facilitators. The sub-merchant''s address. + + ' $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. + + * Format: Alphanumeric + + * 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. + + * Format: Numeric + + * 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