diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index f669435..82dd157 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -5640,7 +5640,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -5656,7 +5656,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -5992,28 +5992,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -6437,25 +6415,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -7647,7 +7606,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -7837,7 +7795,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7856,7 +7814,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8006,7 +7964,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8025,7 +7983,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8420,7 +8378,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8432,7 +8390,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8901,9 +8859,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -8922,9 +8877,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -9056,7 +9008,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -9897,6 +9849,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -10516,7 +10479,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -12486,150 +12450,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index c12401b..7676c97 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -5882,7 +5882,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -5903,7 +5903,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6255,28 +6255,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -6700,25 +6678,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -7969,7 +7928,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8168,7 +8126,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8187,7 +8145,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8337,7 +8295,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8356,7 +8314,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8751,7 +8709,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8763,7 +8721,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9253,9 +9211,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -9274,9 +9229,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -9408,7 +9360,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10273,6 +10225,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -10934,7 +10897,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -13072,150 +13036,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index 46726b1..9edaffe 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -5895,7 +5895,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -5916,7 +5916,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6268,28 +6268,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -6713,25 +6691,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -7982,7 +7941,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8186,7 +8144,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8205,7 +8163,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8355,7 +8313,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8374,7 +8332,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8769,7 +8727,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8781,7 +8739,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9271,9 +9229,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -9292,9 +9247,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -9426,7 +9378,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10296,6 +10248,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -10957,7 +10920,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -13129,150 +13093,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index f2d8b38..7f607de 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -5895,7 +5895,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -5916,7 +5916,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6268,28 +6268,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -6713,25 +6691,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -7982,7 +7941,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8186,7 +8144,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8205,7 +8163,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8355,7 +8313,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8374,7 +8332,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8769,7 +8727,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8781,7 +8739,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9271,9 +9229,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -9292,9 +9247,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -9426,7 +9378,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10296,6 +10248,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -10965,7 +10928,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -13137,150 +13101,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 7d17ad1..ad52ac9 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -6387,7 +6387,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6408,7 +6408,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6770,28 +6770,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7242,34 +7220,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8637,7 +8587,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8850,7 +8799,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8869,7 +8818,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9019,7 +8968,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9038,7 +8987,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9441,7 +9390,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9453,7 +9402,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9540,14 +9489,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -9963,9 +9905,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -9984,9 +9923,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10118,7 +10054,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10590,66 +10526,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11126,6 +11002,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -11888,7 +11775,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -14166,150 +14054,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index b1df8ee..d07d573 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -6409,7 +6409,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6430,7 +6430,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6798,28 +6798,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7270,34 +7248,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8665,7 +8615,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8878,7 +8827,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8897,7 +8846,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9052,7 +9001,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9071,7 +9020,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9479,7 +9428,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9491,7 +9440,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9578,14 +9527,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10001,9 +9943,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10022,9 +9961,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10156,7 +10092,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10634,66 +10570,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11170,6 +11046,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -11932,7 +11819,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -14245,150 +14133,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index 31d4858..256ec2e 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -6415,7 +6415,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6436,7 +6436,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6810,28 +6810,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7282,34 +7260,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8677,7 +8627,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8890,7 +8839,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8909,7 +8858,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9064,7 +9013,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9083,7 +9032,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9498,7 +9447,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9510,7 +9459,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9603,14 +9552,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10032,9 +9974,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10053,9 +9992,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10187,7 +10123,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10665,66 +10601,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11201,6 +11077,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -11963,7 +11850,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -12914,7 +12802,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -14279,150 +14167,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17358,7 +17102,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17405,8 +17149,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17453,7 +17197,7 @@ "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "javaEnabled" : true }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17527,7 +17271,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17661,7 +17405,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17697,7 +17441,7 @@ "type" : "paywithgoogle", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17712,7 +17456,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17809,7 +17553,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17827,7 +17571,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18101,7 +17845,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18227,7 +17971,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18265,7 +18009,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 9ac8f46..88b1594 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -6415,7 +6415,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6436,7 +6436,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6818,28 +6818,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7290,34 +7268,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8685,7 +8635,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8903,7 +8852,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8922,7 +8871,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9077,7 +9026,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9096,7 +9045,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9511,7 +9460,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9523,7 +9472,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9616,14 +9565,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10045,9 +9987,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10066,9 +10005,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10200,7 +10136,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10683,66 +10619,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11219,6 +11095,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -11981,7 +11868,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -12932,7 +12820,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -13080,7 +12968,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -13120,7 +13008,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -14303,150 +14191,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17382,7 +17126,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17429,8 +17173,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17477,7 +17221,7 @@ "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "javaEnabled" : true }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17514,7 +17258,7 @@ "encryptedSecurityCode" : "test_737", "holderName" : "John Smith" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17551,7 +17295,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17587,7 +17331,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17661,7 +17405,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17685,7 +17429,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17721,7 +17465,7 @@ "type" : "paywithgoogle", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17736,7 +17480,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17833,7 +17577,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17851,7 +17595,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18125,7 +17869,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18148,7 +17892,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18254,7 +17998,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18292,7 +18036,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index fe637e6..76ab5d1 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -6415,7 +6415,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6436,7 +6436,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6818,28 +6818,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7290,34 +7268,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8685,7 +8635,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8903,7 +8852,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8922,7 +8871,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9077,7 +9026,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9096,7 +9045,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9520,7 +9469,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9532,7 +9481,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9631,14 +9580,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10060,9 +10002,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10081,9 +10020,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10215,7 +10151,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10698,66 +10634,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11243,6 +11119,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -12005,7 +11892,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -12956,7 +12844,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -13104,7 +12992,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -13144,7 +13032,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -14327,150 +14215,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17406,7 +17150,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17453,8 +17197,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17501,7 +17245,7 @@ "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "javaEnabled" : true }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17538,7 +17282,7 @@ "encryptedSecurityCode" : "test_737", "holderName" : "John Smith" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17575,7 +17319,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17611,7 +17355,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17685,7 +17429,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17709,7 +17453,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17745,7 +17489,7 @@ "type" : "paywithgoogle", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17760,7 +17504,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17857,7 +17601,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17875,7 +17619,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18149,7 +17893,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18172,7 +17916,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18278,7 +18022,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18316,7 +18060,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index b583398..a51da2e 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -6415,7 +6415,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6436,7 +6436,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6818,28 +6818,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7290,34 +7268,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8737,7 +8687,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8969,7 +8918,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8988,7 +8937,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9143,7 +9092,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9162,7 +9111,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9586,7 +9535,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9598,7 +9547,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9702,14 +9651,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10131,9 +10073,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10152,9 +10091,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10286,7 +10222,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10783,66 +10719,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11328,6 +11204,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -12090,7 +11977,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -13041,7 +12929,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -13189,7 +13077,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -13229,7 +13117,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -14412,150 +14300,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17491,7 +17235,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17538,8 +17282,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17586,7 +17330,7 @@ "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "javaEnabled" : true }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17623,7 +17367,7 @@ "encryptedSecurityCode" : "test_737", "holderName" : "John Smith" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17660,7 +17404,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17696,7 +17440,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17770,7 +17514,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17794,7 +17538,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17830,7 +17574,7 @@ "type" : "paywithgoogle", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17845,7 +17589,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17942,7 +17686,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17960,7 +17704,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18234,7 +17978,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18257,7 +18001,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18363,7 +18107,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18401,7 +18145,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index a051a45..853b2d3 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -6331,7 +6331,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6352,7 +6352,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6728,28 +6728,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7200,34 +7178,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8647,7 +8597,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8879,7 +8828,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8898,7 +8847,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9058,7 +9007,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9077,7 +9026,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9486,7 +9435,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9498,7 +9447,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9582,14 +9531,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10005,9 +9947,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10026,9 +9965,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10160,7 +10096,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10657,66 +10593,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11126,6 +11002,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -11881,7 +11768,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -12834,7 +12722,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -12982,7 +12870,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -13022,7 +12910,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -14205,150 +14093,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17299,7 +17043,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17346,8 +17090,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17394,7 +17138,7 @@ "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "javaEnabled" : true }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17431,7 +17175,7 @@ "encryptedSecurityCode" : "test_737", "holderName" : "John Smith" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17468,7 +17212,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17504,7 +17248,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17578,7 +17322,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17602,7 +17346,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17638,7 +17382,7 @@ "type" : "paywithgoogle", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17653,7 +17397,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17750,7 +17494,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17768,7 +17512,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18042,7 +17786,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18065,7 +17809,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18171,7 +17915,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18209,7 +17953,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 6f3bb2a..0d7ea24 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -6331,7 +6331,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6352,7 +6352,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6728,28 +6728,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7200,34 +7178,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8647,7 +8597,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -8884,7 +8833,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8903,7 +8852,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9063,7 +9012,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9082,7 +9031,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9491,7 +9440,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9503,7 +9452,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9587,14 +9536,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10010,9 +9952,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10031,9 +9970,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10165,7 +10101,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10667,66 +10603,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11136,6 +11012,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -11891,7 +11778,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -12844,7 +12732,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -12992,7 +12880,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -13032,7 +12920,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -14215,150 +14103,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17309,7 +17053,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17356,8 +17100,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17404,7 +17148,7 @@ "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", "javaEnabled" : true }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17441,7 +17185,7 @@ "encryptedSecurityCode" : "test_737", "holderName" : "John Smith" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17478,7 +17222,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17514,7 +17258,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17588,7 +17332,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17612,7 +17356,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17648,7 +17392,7 @@ "type" : "paywithgoogle", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17663,7 +17407,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17760,7 +17504,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17778,7 +17522,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18052,7 +17796,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18075,7 +17819,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18181,7 +17925,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18219,7 +17963,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index ecd9916..530d72b 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -6584,7 +6584,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6605,7 +6605,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6986,28 +6986,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -7458,34 +7436,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -8905,7 +8855,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -9099,7 +9048,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9118,7 +9067,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9298,7 +9247,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9317,7 +9266,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9746,7 +9695,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9758,7 +9707,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -9842,14 +9791,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -10265,9 +10207,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -10286,9 +10225,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -10420,7 +10356,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -10885,76 +10821,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "iban" : { - "x-addedInVersion" : "67", - "description" : "The IBAN of the bank account.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "ownerName" : { - "x-addedInVersion" : "67", - "description" : "The name of the bank account holder.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -11339,6 +11205,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -12104,7 +11981,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -13179,7 +13057,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -13379,7 +13257,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -13421,7 +13299,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationCampaignId" : "DONATION_CAMPAIGN_ID", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -13459,7 +13337,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -14642,150 +14520,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17736,7 +17470,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17780,8 +17514,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17811,7 +17545,7 @@ "timeZoneOffset" : 5, "language" : "en" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17831,7 +17565,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17868,7 +17602,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17934,7 +17668,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17979,7 +17713,7 @@ "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", "storePaymentMethod" : true, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18016,7 +17750,7 @@ "type" : "googlepay", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -18031,7 +17765,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18123,7 +17857,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18141,7 +17875,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "CardOnFile" @@ -18417,7 +18151,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18440,7 +18174,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18546,7 +18280,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18587,7 +18321,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index 00d95ab..6e43e8d 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -5115,7 +5115,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters.", + "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character set for Visa, Mastercard and JCB payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital letters, numbers and special characters. \n* Half-width or full-width characters.", "type" : "object" }, "mcc" : { @@ -6623,7 +6623,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6642,7 +6642,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6957,7 +6957,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6976,7 +6976,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7694,7 +7694,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7715,7 +7715,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8117,33 +8117,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -8624,39 +8597,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -10206,7 +10146,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -10400,7 +10339,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10419,7 +10358,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10610,7 +10549,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10629,7 +10568,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11093,7 +11032,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11105,7 +11044,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11189,14 +11128,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -11629,9 +11561,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -11650,9 +11579,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -11789,7 +11715,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -12259,81 +12185,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The year the card expires, for example **2022**.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "iban" : { - "x-addedInVersion" : "67", - "description" : "The IBAN of the bank account.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "networkTxReference" : { - "x-addedInVersion" : "68", - "description" : "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.", - "type" : "string" - }, - "ownerName" : { - "x-addedInVersion" : "67", - "description" : "The name of the bank account holder.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -12733,6 +12584,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -13551,7 +13413,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -14996,7 +14859,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -15204,7 +15067,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -15246,7 +15109,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationCampaignId" : "DONATION_CAMPAIGN_ID", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -15284,7 +15147,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -15336,7 +15199,7 @@ } }, "post-orders-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Order created", "value" : { "pspReference" : "8616178914061985", "resultCode" : "Success", @@ -15811,10 +15674,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17322,7 +17181,7 @@ "type" : "applepay", "applePayToken" : "VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU..." }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17366,8 +17225,8 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", - "returnUrl" : "https://your-company.com/checkout/", + "origin" : "https://your-company.example.com", + "returnUrl" : "https://your-company.example.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17397,7 +17256,7 @@ "timeZoneOffset" : 5, "language" : "en" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17417,7 +17276,7 @@ "holderName" : "John Smith", "cvc" : "737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17454,7 +17313,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17520,7 +17379,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17565,7 +17424,7 @@ "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", "storePaymentMethod" : true, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17602,7 +17461,7 @@ "type" : "googlepay", "googlePayToken" : "==Payload as retrieved from Google Pay response==" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YourMerchantAccount" } }, @@ -17617,7 +17476,7 @@ "paymentMethod" : { "type" : "ideal" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17709,7 +17568,7 @@ "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17727,7 +17586,7 @@ "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "CardOnFile" @@ -18003,7 +17862,7 @@ "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth", "recurringProcessingModel" : "Subscription" @@ -18026,7 +17885,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18064,7 +17923,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "platformChargebackLogic" : { "behavior" : "deductFromOneBalanceAccount", "targetAccount" : "BA00000000000000000000001", @@ -18141,7 +18000,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18291,7 +18150,7 @@ "value" : 100, "currency" : "EUR" }, - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "reference" : "YOUR_PAYMENT_REFERENCE", "countryCode" : "NL" } @@ -18309,7 +18168,7 @@ "id" : "CS451F2AB1ED897A94", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "reference" : "YOUR_PAYMENT_REFERENCE", - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "sessionData" : "Ab02b4c0!BQABAgBfYI29..." } }, @@ -18450,7 +18309,7 @@ "currency" : "EUR" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "reference" : "YOUR_PAYMENT_REFERENCE", "countryCode" : "NL", "storePaymentMethod" : true, @@ -18473,7 +18332,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "recurringProcessingModel" : "CardOnFile", "reference" : "YOUR_PAYMENT_REFERENCE", - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "shopperInteraction" : "Ecommerce", "storePaymentMethod" : true, "sessionData" : "Ab02b4c0!BQABAgBfYI29..." @@ -18488,7 +18347,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18530,7 +18389,7 @@ "id" : "CSFCBC80570618EF2C", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "reference" : "YOUR_ORDER_NUMBER", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "shopperLocale" : "en-US", "splits" : [ { diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index 2e62fa5..a3537fc 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -5147,7 +5147,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters.", + "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character set for Visa, Mastercard and JCB payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital letters, numbers and special characters. \n* Half-width or full-width characters.", "type" : "object" }, "mcc" : { @@ -6694,7 +6694,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6718,7 +6718,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7051,7 +7051,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7075,7 +7075,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7818,7 +7818,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7844,7 +7844,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8249,33 +8249,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -8749,39 +8722,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -10331,7 +10271,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -10538,7 +10477,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10557,7 +10496,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10784,7 +10723,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10803,7 +10742,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11303,7 +11242,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11315,7 +11254,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11399,14 +11338,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -11844,9 +11776,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -11865,9 +11794,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -12004,7 +11930,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -12485,81 +12411,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The last two digits of the year the card expires. For example, **22** for the year 2022.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "iban" : { - "x-addedInVersion" : "67", - "description" : "The IBAN of the bank account.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "networkTxReference" : { - "x-addedInVersion" : "68", - "description" : "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.", - "type" : "string" - }, - "ownerName" : { - "x-addedInVersion" : "67", - "description" : "The name of the bank account holder.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -12959,6 +12810,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -13792,7 +13654,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -15275,7 +15138,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -15483,7 +15346,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -15525,7 +15388,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationCampaignId" : "DONATION_CAMPAIGN_ID", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -15563,7 +15426,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -15615,7 +15478,7 @@ } }, "post-orders-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Order created", "value" : { "pspReference" : "8616178914061985", "resultCode" : "Success", @@ -16090,10 +15953,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" @@ -17647,7 +17506,7 @@ "javaEnabled" : true }, "channel" : "Web", - "origin" : "https://your-company.com", + "origin" : "https://your-company.example.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } @@ -17678,7 +17537,7 @@ "timeZoneOffset" : 5, "language" : "en" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17735,7 +17594,7 @@ "encryptedExpiryYear" : "test_2030", "encryptedSecurityCode" : "test_737" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17801,7 +17660,7 @@ "storePaymentMethod" : true, "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -17846,7 +17705,7 @@ "shopperInteraction" : "Ecommerce", "recurringProcessingModel" : "CardOnFile", "storePaymentMethod" : true, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -18307,7 +18166,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "platformChargebackLogic" : { "behavior" : "deductFromOneBalanceAccount", "targetAccount" : "BA00000000000000000000001", @@ -18419,7 +18278,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18610,7 +18469,7 @@ "value" : 100, "currency" : "EUR" }, - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "reference" : "YOUR_PAYMENT_REFERENCE", "countryCode" : "NL" } @@ -18628,7 +18487,7 @@ "id" : "CS451F2AB1ED897A94", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "reference" : "YOUR_PAYMENT_REFERENCE", - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "sessionData" : "Ab02b4c0!BQABAgBfYI29..." } }, @@ -18769,7 +18628,7 @@ "currency" : "EUR" }, "shopperReference" : "YOUR_SHOPPER_REFERENCE", - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "reference" : "YOUR_PAYMENT_REFERENCE", "countryCode" : "NL", "storePaymentMethod" : true, @@ -18792,7 +18651,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "recurringProcessingModel" : "CardOnFile", "reference" : "YOUR_PAYMENT_REFERENCE", - "returnUrl" : "https://your-company.com/checkout?shopperOrder=12xy..", + "returnUrl" : "https://your-company.example.com/checkout?shopperOrder=12xy..", "shopperInteraction" : "Ecommerce", "storePaymentMethod" : true, "sessionData" : "Ab02b4c0!BQABAgBfYI29..." @@ -18807,7 +18666,7 @@ }, "reference" : "YOUR_ORDER_NUMBER", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "splits" : [ { "amount" : { @@ -18849,7 +18708,7 @@ "id" : "CSFCBC80570618EF2C", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "reference" : "YOUR_ORDER_NUMBER", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "shopperLocale" : "en-US", "splits" : [ { diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index b4249bc..cb05ae1 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -4758,6 +4758,84 @@ "title" : "Afterpay", "type" : "object" }, + "Agency" : { + "additionalProperties" : false, + "properties" : { + "invoiceNumber" : { + "description" : "The reference number for the invoice, issued by the agency.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 6 characters", + "type" : "string" + }, + "planName" : { + "description" : "The two-letter agency plan identifier.\n* Encoding: ASCII\n* minLength: 2 characters\n* maxLength: 2 characters", + "type" : "string" + } + }, + "type" : "object" + }, + "Airline" : { + "additionalProperties" : false, + "properties" : { + "agency" : { + "$ref" : "#/components/schemas/Agency" + }, + "boardingFee" : { + "description" : "The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1 character\n* maxLength: 11 characters", + "format" : "int64", + "type" : "integer" + }, + "code" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "computerizedReservationSystem" : { + "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Encoding: ASCII\n* minLength: 4 characters\n* maxLength: 4 characters", + "type" : "string" + }, + "customerReferenceNumber" : { + "description" : "The alphanumeric customer reference number.\n* Encoding: ASCII\n* maxLength: 20 characters\n* If you send more than 20 characters, the customer reference number is truncated\n* Must not start with a space or be all spaces.", + "type" : "string" + }, + "designatorCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not start with a space or be all spaces.", + "type" : "string" + }, + "documentType" : { + "description" : "A code that identifies the type of item bought. The description of the code can appear on credit card statements.\n* Encoding: ASCII\n* Example: Passenger ticket = 01\n* minLength: 2 characters\n* maxLength: 2 characters", + "type" : "string" + }, + "flightDate" : { + "description" : "The flight departure date. Time is optional.\n* Format for date only: `yyyy-MM-dd`\n* Format for date and time: `yyyy-MM-ddTHH:mm`\n* Use local time of departure airport.\n* minLength: 10 characters\n* maxLength: 16 characters", + "format" : "date-time", + "type" : "string" + }, + "legs" : { + "items" : { + "$ref" : "#/components/schemas/Leg" + }, + "type" : "array" + }, + "passengerName" : { + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "passengers" : { + "items" : { + "$ref" : "#/components/schemas/Passenger" + }, + "type" : "array" + }, + "ticket" : { + "$ref" : "#/components/schemas/Ticket" + }, + "travelAgency" : { + "$ref" : "#/components/schemas/TravelAgency" + } + }, + "required" : [ + "passengerName" + ], + "type" : "object" + }, "AmazonPayDetails" : { "additionalProperties" : false, "properties" : { @@ -5259,7 +5337,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters.", + "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character set for Visa, Mastercard and JCB payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital letters, numbers and special characters. \n* Half-width or full-width characters.", "type" : "object" }, "mcc" : { @@ -6806,7 +6884,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6830,7 +6908,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7178,7 +7256,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7202,7 +7280,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7970,7 +8048,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7996,7 +8074,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8417,33 +8495,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -8619,6 +8670,16 @@ ], "type" : "object" }, + "EnhancedSchemeData" : { + "additionalProperties" : false, + "properties" : { + "airline" : { + "description" : "[Airline enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/airline/) that may be required for processing the transaction and/or for interchange savings.", + "$ref" : "#/components/schemas/Airline" + } + }, + "type" : "object" + }, "ExternalPlatform" : { "additionalProperties" : false, "properties" : { @@ -8917,39 +8978,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -9350,6 +9378,50 @@ "title" : "Klarna", "type" : "object" }, + "Leg" : { + "additionalProperties" : false, + "properties" : { + "carrierCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "classOfTravel" : { + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "dateOfTravel" : { + "description" : "Date and time of travel in format `yyyy-MM-ddTHH:mm`.\n* Use local time of departure airport.\n* minLength: 16 characters\n* maxLength: 16 characters", + "format" : "date-time", + "type" : "string" + }, + "departureAirportCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "departureTax" : { + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 11\n* Must not be all zeros.", + "format" : "int64", + "type" : "integer" + }, + "destinationAirportCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "fareBasisCode" : { + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "flightNumber" : { + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "stopOverCode" : { + "description" : "A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character", + "type" : "string" + } + }, + "type" : "object" + }, "LineItem" : { "additionalProperties" : false, "properties" : { @@ -9817,6 +9889,33 @@ "title" : "Open Invoice", "type" : "object" }, + "Passenger" : { + "additionalProperties" : false, + "properties" : { + "dateOfBirth" : { + "description" : "The passenger's date of birth.\n* Format `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", + "format" : "date", + "type" : "string" + }, + "firstName" : { + "description" : "The passenger's first name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII", + "type" : "string" + }, + "lastName" : { + "description" : "The passenger's last name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The passenger's phone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 30 characters", + "type" : "string" + }, + "travellerType" : { + "description" : "The IATA passenger type code (PTC).\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 6 characters", + "type" : "string" + } + }, + "type" : "object" + }, "PayByBankAISDirectDebitDetails" : { "additionalProperties" : false, "properties" : { @@ -10339,6 +10438,11 @@ "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, + "enhancedSchemeData" : { + "x-addedInVersion" : "70", + "description" : "Enhanced scheme data that may be required for processing the payment. For example, airline information.", + "$ref" : "#/components/schemas/EnhancedSchemeData" + }, "lineItems" : { "description" : "Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).\n> This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.", "items" : { @@ -10598,7 +10702,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -10805,7 +10908,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10824,7 +10927,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11051,7 +11154,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11070,7 +11173,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11570,7 +11673,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11582,7 +11685,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11666,14 +11769,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -11987,6 +12083,11 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.", "type" : "boolean" }, + "enhancedSchemeData" : { + "x-addedInVersion" : "70", + "description" : "[Enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/) that may be required for processing the payment and/or interchange savings can apply.", + "$ref" : "#/components/schemas/EnhancedSchemeData" + }, "entityType" : { "description" : "The type of the entity the payment is processed for.", "enum" : [ @@ -12130,9 +12231,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -12151,9 +12249,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -12290,7 +12385,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -12771,94 +12866,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The last two digits of the year the card expires. For example, **22** for the year 2022.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "iban" : { - "x-addedInVersion" : "67", - "description" : "The IBAN of the bank account.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "label" : { - "x-addedInVersion" : "70", - "description" : "The shopper’s issuer account label", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "networkTxReference" : { - "x-addedInVersion" : "68", - "description" : "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.", - "type" : "string" - }, - "ownerName" : { - "x-addedInVersion" : "67", - "description" : "The name of the bank account holder.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedRecurringProcessingModels" : { - "x-addedInVersion" : "70", - "description" : "The supported recurring processing models for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -13258,6 +13265,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -14104,7 +14122,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -15179,6 +15198,39 @@ }, "type" : "object" }, + "Ticket" : { + "additionalProperties" : false, + "properties" : { + "issueAddress" : { + "description" : "The address of the organization that issued the ticket.\n* minLength: 0 characters\n* maxLength: 16 characters", + "type" : "string" + }, + "issueDate" : { + "description" : "The date that the ticket was issued to the passenger.\n* minLength: 10 characters\n* maxLength: 10 characters\n* Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd", + "format" : "date", + "type" : "string" + }, + "number" : { + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + } + }, + "type" : "object" + }, + "TravelAgency" : { + "additionalProperties" : false, + "properties" : { + "code" : { + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "name" : { + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + } + }, + "type" : "object" + }, "TwintDetails" : { "additionalProperties" : false, "properties" : { @@ -15595,7 +15647,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -15830,7 +15882,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -15872,7 +15924,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationCampaignId" : "DONATION_CAMPAIGN_ID", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -15910,7 +15962,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -15962,7 +16014,7 @@ } }, "post-orders-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Order created", "value" : { "pspReference" : "8616178914061985", "resultCode" : "Success", @@ -16437,10 +16489,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/json/CheckoutService-v71.json b/json/CheckoutService-v71.json index 149cea4..cdfb6f1 100644 --- a/json/CheckoutService-v71.json +++ b/json/CheckoutService-v71.json @@ -4758,6 +4758,84 @@ "title" : "Afterpay", "type" : "object" }, + "Agency" : { + "additionalProperties" : false, + "properties" : { + "invoiceNumber" : { + "description" : "The reference number for the invoice, issued by the agency.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 6 characters", + "type" : "string" + }, + "planName" : { + "description" : "The two-letter agency plan identifier.\n* Encoding: ASCII\n* minLength: 2 characters\n* maxLength: 2 characters", + "type" : "string" + } + }, + "type" : "object" + }, + "Airline" : { + "additionalProperties" : false, + "properties" : { + "agency" : { + "$ref" : "#/components/schemas/Agency" + }, + "boardingFee" : { + "description" : "The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1 character\n* maxLength: 11 characters", + "format" : "int64", + "type" : "integer" + }, + "code" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "computerizedReservationSystem" : { + "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Encoding: ASCII\n* minLength: 4 characters\n* maxLength: 4 characters", + "type" : "string" + }, + "customerReferenceNumber" : { + "description" : "The alphanumeric customer reference number.\n* Encoding: ASCII\n* maxLength: 20 characters\n* If you send more than 20 characters, the customer reference number is truncated\n* Must not start with a space or be all spaces.", + "type" : "string" + }, + "designatorCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not start with a space or be all spaces.", + "type" : "string" + }, + "documentType" : { + "description" : "A code that identifies the type of item bought. The description of the code can appear on credit card statements.\n* Encoding: ASCII\n* Example: Passenger ticket = 01\n* minLength: 2 characters\n* maxLength: 2 characters", + "type" : "string" + }, + "flightDate" : { + "description" : "The flight departure date. Time is optional.\n* Format for date only: `yyyy-MM-dd`\n* Format for date and time: `yyyy-MM-ddTHH:mm`\n* Use local time of departure airport.\n* minLength: 10 characters\n* maxLength: 16 characters", + "format" : "date-time", + "type" : "string" + }, + "legs" : { + "items" : { + "$ref" : "#/components/schemas/Leg" + }, + "type" : "array" + }, + "passengerName" : { + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "passengers" : { + "items" : { + "$ref" : "#/components/schemas/Passenger" + }, + "type" : "array" + }, + "ticket" : { + "$ref" : "#/components/schemas/Ticket" + }, + "travelAgency" : { + "$ref" : "#/components/schemas/TravelAgency" + } + }, + "required" : [ + "passengerName" + ], + "type" : "object" + }, "AmazonPayDetails" : { "additionalProperties" : false, "properties" : { @@ -5259,7 +5337,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters.", + "description" : "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character set for Visa, Mastercard and JCB payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital letters, numbers and special characters. \n* Half-width or full-width characters.", "type" : "object" }, "mcc" : { @@ -6806,7 +6884,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -6830,7 +6908,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7178,7 +7256,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -7202,7 +7280,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -8241,33 +8319,6 @@ }, "type" : "object" }, - "DotpayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "issuer" : { - "description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.", - "type" : "string" - }, - "type" : { - "default" : "dotpay", - "description" : "**dotpay**", - "enum" : [ - "dotpay" - ], - "type" : "string" - } - }, - "required" : [ - "issuer" - ], - "title" : "Dotpay", - "type" : "object" - }, "DragonpayDetails" : { "additionalProperties" : false, "properties" : { @@ -8443,6 +8494,16 @@ ], "type" : "object" }, + "EnhancedSchemeData" : { + "additionalProperties" : false, + "properties" : { + "airline" : { + "description" : "[Airline enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/airline/) that may be required for processing the transaction and/or for interchange savings.", + "$ref" : "#/components/schemas/Airline" + } + }, + "type" : "object" + }, "ExternalPlatform" : { "additionalProperties" : false, "properties" : { @@ -8741,39 +8802,6 @@ "title" : "Stored Payment Method", "type" : "object" }, - "GiropayDetails" : { - "additionalProperties" : false, - "properties" : { - "checkoutAttemptId" : { - "x-addedInVersion" : "68", - "description" : "The checkout attempt identifier.", - "type" : "string" - }, - "recurringDetailReference" : { - "deprecated" : true, - "x-deprecatedInVersion" : "49", - "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "type" : "string" - }, - "storedPaymentMethodId" : { - "x-addedInVersion" : "49", - "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", - "maxLength" : 64, - "type" : "string" - }, - "type" : { - "default" : "giropay", - "description" : "**giropay**", - "enum" : [ - "giropay" - ], - "type" : "string" - } - }, - "title" : "Giropay", - "type" : "object" - }, "GooglePayDetails" : { "additionalProperties" : false, "properties" : { @@ -9174,6 +9202,50 @@ "title" : "Klarna", "type" : "object" }, + "Leg" : { + "additionalProperties" : false, + "properties" : { + "carrierCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "classOfTravel" : { + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "dateOfTravel" : { + "description" : "Date and time of travel in format `yyyy-MM-ddTHH:mm`.\n* Use local time of departure airport.\n* minLength: 16 characters\n* maxLength: 16 characters", + "format" : "date-time", + "type" : "string" + }, + "departureAirportCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "departureTax" : { + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 11\n* Must not be all zeros.", + "format" : "int64", + "type" : "integer" + }, + "destinationAirportCode" : { + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "fareBasisCode" : { + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "flightNumber" : { + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "stopOverCode" : { + "description" : "A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character", + "type" : "string" + } + }, + "type" : "object" + }, "LineItem" : { "additionalProperties" : false, "properties" : { @@ -9641,6 +9713,33 @@ "title" : "Open Invoice", "type" : "object" }, + "Passenger" : { + "additionalProperties" : false, + "properties" : { + "dateOfBirth" : { + "description" : "The passenger's date of birth.\n* Format `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", + "format" : "date", + "type" : "string" + }, + "firstName" : { + "description" : "The passenger's first name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII", + "type" : "string" + }, + "lastName" : { + "description" : "The passenger's last name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The passenger's phone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 30 characters", + "type" : "string" + }, + "travellerType" : { + "description" : "The IATA passenger type code (PTC).\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 6 characters", + "type" : "string" + } + }, + "type" : "object" + }, "PayByBankAISDirectDebitDetails" : { "additionalProperties" : false, "properties" : { @@ -10171,6 +10270,11 @@ "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, + "enhancedSchemeData" : { + "x-addedInVersion" : "70", + "description" : "Enhanced scheme data that may be required for processing the payment. For example, airline information.", + "$ref" : "#/components/schemas/EnhancedSchemeData" + }, "lineItems" : { "description" : "Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).\n> This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.", "items" : { @@ -10430,7 +10534,6 @@ "directEbanking", "boletobancario", "neteller", - "paysafecard", "cashticket", "ikano", "karenmillen", @@ -10637,7 +10740,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10656,7 +10759,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10885,7 +10988,7 @@ "additionalProperties" : false, "properties" : { "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -10904,7 +11007,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11406,7 +11509,7 @@ }, "allowedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11418,7 +11521,7 @@ }, "blockedPaymentMethods" : { "x-addedInVersion" : "37", - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"applepay\"]`", "items" : { "type" : "string" }, @@ -11502,14 +11605,7 @@ "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { - "oneOf" : [ - { - "$ref" : "#/components/schemas/PixStoredPaymentMethod" - }, - { - "$ref" : "#/components/schemas/StoredPaymentMethod" - } - ] + "$ref" : "#/components/schemas/StoredPaymentMethod" }, "type" : "array" } @@ -11823,6 +11919,11 @@ "description" : "When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.", "type" : "boolean" }, + "enhancedSchemeData" : { + "x-addedInVersion" : "70", + "description" : "[Enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/) that may be required for processing the payment and/or interchange savings can apply.", + "$ref" : "#/components/schemas/EnhancedSchemeData" + }, "entityType" : { "description" : "The type of the entity the payment is processed for.", "enum" : [ @@ -11966,9 +12067,6 @@ { "$ref" : "#/components/schemas/DokuDetails" }, - { - "$ref" : "#/components/schemas/DotpayDetails" - }, { "$ref" : "#/components/schemas/DragonpayDetails" }, @@ -11987,9 +12085,6 @@ { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, - { - "$ref" : "#/components/schemas/GiropayDetails" - }, { "$ref" : "#/components/schemas/GooglePayDetails" }, @@ -12126,7 +12221,7 @@ "type" : "string" }, "returnUrl" : { - "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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`\n\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.", + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. \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.example.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`\n\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.", "type" : "string" }, "riskData" : { @@ -12607,94 +12702,6 @@ "title" : "pixRecurring", "type" : "object" }, - "PixStoredPaymentMethod" : { - "additionalProperties" : false, - "properties" : { - "bankAccountNumber" : { - "description" : "The bank account number (without separators).", - "type" : "string" - }, - "bankLocationId" : { - "description" : "The location id of the bank. The field value is `nil` in most cases.", - "type" : "string" - }, - "brand" : { - "description" : "The brand of the card.", - "type" : "string" - }, - "expiryMonth" : { - "description" : "The two-digit month when the card expires", - "type" : "string" - }, - "expiryYear" : { - "description" : "The last two digits of the year the card expires. For example, **22** for the year 2022.", - "type" : "string" - }, - "holderName" : { - "description" : "The unique payment method code.", - "type" : "string" - }, - "iban" : { - "x-addedInVersion" : "67", - "description" : "The IBAN of the bank account.", - "type" : "string" - }, - "id" : { - "description" : "A unique identifier of this stored payment method.", - "type" : "string" - }, - "label" : { - "x-addedInVersion" : "70", - "description" : "The shopper’s issuer account label", - "type" : "string" - }, - "lastFour" : { - "description" : "The last four digits of the PAN.", - "type" : "string" - }, - "name" : { - "description" : "The display name of the stored payment method.", - "type" : "string" - }, - "networkTxReference" : { - "x-addedInVersion" : "68", - "description" : "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.", - "type" : "string" - }, - "ownerName" : { - "x-addedInVersion" : "67", - "description" : "The name of the bank account holder.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "The shopper’s email address.", - "type" : "string" - }, - "supportedRecurringProcessingModels" : { - "x-addedInVersion" : "70", - "description" : "The supported recurring processing models for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "supportedShopperInteractions" : { - "description" : "The supported shopper interactions for this stored payment method.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "type" : { - "description" : "The type of payment method.", - "enum" : [ - "pix" - ], - "type" : "string" - } - }, - "type" : "object" - }, "PlatformChargebackLogic" : { "additionalProperties" : false, "properties" : { @@ -13094,6 +13101,17 @@ ], "type" : "string" }, + "fraudRiskLevel" : { + "description" : "The risk level of the payment as determined by the FDM machine learning model.", + "enum" : [ + "Very low", + "Low", + "Medium", + "High", + "Very high" + ], + "type" : "string" + }, "fundingSource" : { "description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type" : "string" @@ -13940,7 +13958,8 @@ "gcash", "dana", "kakaopay", - "truemoney" + "truemoney", + "paysafecard" ], "type" : "string" } @@ -15015,6 +15034,39 @@ }, "type" : "object" }, + "Ticket" : { + "additionalProperties" : false, + "properties" : { + "issueAddress" : { + "description" : "The address of the organization that issued the ticket.\n* minLength: 0 characters\n* maxLength: 16 characters", + "type" : "string" + }, + "issueDate" : { + "description" : "The date that the ticket was issued to the passenger.\n* minLength: 10 characters\n* maxLength: 10 characters\n* Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd", + "format" : "date", + "type" : "string" + }, + "number" : { + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + } + }, + "type" : "object" + }, + "TravelAgency" : { + "additionalProperties" : false, + "properties" : { + "code" : { + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + }, + "name" : { + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not start with a space or be all spaces.\n* Must not be all zeros.", + "type" : "string" + } + }, + "type" : "object" + }, "TwintDetails" : { "additionalProperties" : false, "properties" : { @@ -15431,7 +15483,7 @@ } }, "get-paymentLinks-linkId-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Payment link details", "value" : { "amount" : { "currency" : "EUR", @@ -15666,7 +15718,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationAccount" : "NONPROFIT_ACCOUNT", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "shopperInteraction" : "ContAuth" } @@ -15708,7 +15760,7 @@ "donationToken" : "YOUR_DONATION_TOKEN", "donationOriginalPspReference" : "991559660454807J", "donationCampaignId" : "DONATION_CAMPAIGN_ID", - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, @@ -15746,7 +15798,7 @@ "type" : "scheme", "recurringDetailReference" : "7219687191761347" }, - "returnUrl" : "https://your-company.com/...", + "returnUrl" : "https://your-company.example.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", "donationAccount" : "NONPROFIT_ACCOUNT", "shopperInteraction" : "ContAuth", @@ -15798,7 +15850,7 @@ } }, "post-orders-basic-200" : { - "summary" : "List of available payment methods", + "summary" : "Order created", "value" : { "pspReference" : "8616178914061985", "resultCode" : "Success", @@ -16273,10 +16325,6 @@ "name" : "DOKU wallet", "type" : "doku_wallet" }, - { - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, { "name" : "Dragonpay Prepaid Credits", "type" : "dragonpay_credits" diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index 7fececf..e222133 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -5232,7 +5232,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5257,7 +5257,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5696,23 +5696,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6058,21 +6041,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -7080,7 +7048,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -7276,7 +7243,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7295,7 +7262,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7487,7 +7454,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7506,7 +7473,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7887,7 +7854,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7902,7 +7869,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8386,14 +8353,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -8476,7 +8441,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -9401,6 +9366,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -10165,6 +10140,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -11497,78 +11473,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 4bb97a0..feb83f2 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -5525,7 +5525,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5555,7 +5555,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6016,23 +6016,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6378,21 +6361,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -7479,7 +7447,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -7685,7 +7652,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7704,7 +7671,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7896,7 +7863,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7915,7 +7882,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8296,7 +8263,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8311,7 +8278,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8823,14 +8790,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -8913,7 +8878,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -9862,6 +9827,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -10658,6 +10633,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12196,78 +12172,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index fdc5879..fd1621b 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -5534,7 +5534,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5564,7 +5564,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6025,23 +6025,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6387,21 +6370,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -7488,7 +7456,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -7698,7 +7665,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7717,7 +7684,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7909,7 +7876,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7928,7 +7895,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8309,7 +8276,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8324,7 +8291,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8836,14 +8803,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -8926,7 +8891,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -9879,6 +9844,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -10675,6 +10650,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12241,78 +12217,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index f821fe3..09453ac 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -5534,7 +5534,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5564,7 +5564,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6025,23 +6025,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6387,21 +6370,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -7488,7 +7456,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -7698,7 +7665,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7717,7 +7684,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7909,7 +7876,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7928,7 +7895,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8309,7 +8276,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8324,7 +8291,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8836,14 +8803,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -8926,7 +8891,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -9879,6 +9844,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -10683,6 +10658,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12249,78 +12225,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 9d647d2..615bea9 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -5930,7 +5930,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5960,7 +5960,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6431,23 +6431,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6820,30 +6803,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8047,7 +8006,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8263,7 +8221,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8282,7 +8240,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8474,7 +8432,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8493,7 +8451,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8880,7 +8838,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8895,7 +8853,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8985,9 +8943,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9420,14 +9376,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9510,7 +9464,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -9996,52 +9950,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10571,6 +10479,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11455,6 +11373,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -13147,78 +13066,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index f6780ce..1dc088c 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -5957,7 +5957,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5987,7 +5987,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6464,23 +6464,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6853,30 +6836,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8080,7 +8039,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8296,7 +8254,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8315,7 +8273,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8512,7 +8470,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8531,7 +8489,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8923,7 +8881,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8938,7 +8896,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9028,9 +8986,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9463,14 +9419,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9553,7 +9507,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10045,52 +9999,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10620,6 +10528,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11504,6 +11422,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -13227,78 +13146,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 06cafda..7799fcb 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -5963,7 +5963,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5993,7 +5993,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6476,23 +6476,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6865,30 +6848,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8092,7 +8051,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8308,7 +8266,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8327,7 +8285,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8524,7 +8482,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8543,7 +8501,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8941,7 +8899,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8956,7 +8914,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9052,9 +9010,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9493,14 +9449,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9583,7 +9537,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10075,52 +10029,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10650,6 +10558,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11534,6 +11452,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12457,7 +12376,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -13260,78 +13179,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -14825,7 +14672,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication @@ -14865,8 +14712,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful card payment with 3D Secure 2 native authentication @@ -14906,7 +14753,7 @@ components: Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 javaEnabled: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: summary: Successful card payment with 3D Secure redirect authentication @@ -14968,7 +14815,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -15072,7 +14919,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15101,7 +14948,7 @@ components: paymentMethod: type: paywithgoogle googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15112,7 +14959,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15187,7 +15034,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15201,7 +15048,7 @@ components: recurringDetailReference: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized payment @@ -15403,7 +15250,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15509,7 +15356,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15536,7 +15383,7 @@ components: holderName: John Smith cvc: '737' shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT storePaymentMethod: true shopperInteraction: Ecommerce diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 46fab64..9552f0c 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -5963,7 +5963,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5993,7 +5993,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6484,23 +6484,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6873,30 +6856,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8100,7 +8059,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8320,7 +8278,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8339,7 +8297,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8536,7 +8494,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8555,7 +8513,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8953,7 +8911,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8968,7 +8926,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9064,9 +9022,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9505,14 +9461,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9595,7 +9549,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10091,52 +10045,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10666,6 +10574,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11550,6 +11468,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12473,7 +12392,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -12587,7 +12506,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -12618,7 +12537,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -13281,78 +13200,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -14846,7 +14693,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication @@ -14886,8 +14733,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful card payment with 3D Secure 2 native authentication @@ -14927,7 +14774,7 @@ components: Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 javaEnabled: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: summary: Successful card payment with 3D Secure redirect authentication @@ -14958,7 +14805,7 @@ components: encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 holderName: John Smith - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: summary: Successful payment with 3D Secure 2 native authentication, using encrypted @@ -14989,7 +14836,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -15018,7 +14865,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -15073,7 +14920,7 @@ components: encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments @@ -15093,7 +14940,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15122,7 +14969,7 @@ components: paymentMethod: type: paywithgoogle googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15133,7 +14980,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15208,7 +15055,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15222,7 +15069,7 @@ components: recurringDetailReference: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized payment @@ -15424,7 +15271,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15443,7 +15290,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39600 @@ -15532,7 +15379,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15559,7 +15406,7 @@ components: holderName: John Smith cvc: '737' shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT storePaymentMethod: true shopperInteraction: Ecommerce diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index d63c4c2..3f6f106 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -5963,7 +5963,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5993,7 +5993,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6484,23 +6484,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6873,30 +6856,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8100,7 +8059,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8320,7 +8278,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8339,7 +8297,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8536,7 +8494,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8555,7 +8513,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8960,7 +8918,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8975,7 +8933,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9077,9 +9035,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9518,14 +9474,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9608,7 +9562,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10104,52 +10058,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10686,6 +10594,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11570,6 +11488,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12493,7 +12412,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -12607,7 +12526,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -12638,7 +12557,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -13301,78 +13220,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -14866,7 +14713,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication @@ -14906,8 +14753,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful card payment with 3D Secure 2 native authentication @@ -14947,7 +14794,7 @@ components: Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 javaEnabled: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: summary: Successful card payment with 3D Secure redirect authentication @@ -14978,7 +14825,7 @@ components: encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 holderName: John Smith - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: summary: Successful payment with 3D Secure 2 native authentication, using encrypted @@ -15009,7 +14856,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -15038,7 +14885,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -15093,7 +14940,7 @@ components: encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments @@ -15113,7 +14960,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15142,7 +14989,7 @@ components: paymentMethod: type: paywithgoogle googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15153,7 +15000,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15228,7 +15075,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15242,7 +15089,7 @@ components: recurringDetailReference: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized payment @@ -15444,7 +15291,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15463,7 +15310,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39600 @@ -15552,7 +15399,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15579,7 +15426,7 @@ components: holderName: John Smith cvc: '737' shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT storePaymentMethod: true shopperInteraction: Ecommerce diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 8542616..18b49a5 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -5963,7 +5963,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5993,7 +5993,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6484,23 +6484,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6873,30 +6856,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8161,7 +8120,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8395,7 +8353,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8414,7 +8372,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8611,7 +8569,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8630,7 +8588,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9035,7 +8993,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9050,7 +9008,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9156,9 +9114,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9597,14 +9553,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9687,7 +9641,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10197,52 +10151,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10779,6 +10687,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11663,6 +11581,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12586,7 +12505,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -12700,7 +12619,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -12731,7 +12650,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -13394,78 +13313,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -14959,7 +14806,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication @@ -14999,8 +14846,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful card payment with 3D Secure 2 native authentication @@ -15040,7 +14887,7 @@ components: Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 javaEnabled: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: summary: Successful card payment with 3D Secure redirect authentication @@ -15071,7 +14918,7 @@ components: encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 holderName: John Smith - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: summary: Successful payment with 3D Secure 2 native authentication, using encrypted @@ -15102,7 +14949,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -15131,7 +14978,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -15186,7 +15033,7 @@ components: encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments @@ -15206,7 +15053,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15235,7 +15082,7 @@ components: paymentMethod: type: paywithgoogle googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15246,7 +15093,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15321,7 +15168,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15335,7 +15182,7 @@ components: recurringDetailReference: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized payment @@ -15537,7 +15384,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15556,7 +15403,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39600 @@ -15645,7 +15492,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15672,7 +15519,7 @@ components: holderName: John Smith cvc: '737' shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT storePaymentMethod: true shopperInteraction: Ecommerce diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index f268b81..e3a24b6 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -5859,7 +5859,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5889,7 +5889,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6374,23 +6374,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6763,30 +6746,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8051,7 +8010,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8285,7 +8243,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8304,7 +8262,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8505,7 +8463,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8524,7 +8482,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8918,7 +8876,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8933,7 +8891,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9023,9 +8981,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9458,14 +9414,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9548,7 +9502,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10058,52 +10012,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10581,6 +10489,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11463,6 +11381,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12388,7 +12307,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -12502,7 +12421,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -12533,7 +12452,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -13196,78 +13115,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -14772,7 +14619,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication @@ -14812,8 +14659,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful card payment with 3D Secure 2 native authentication @@ -14853,7 +14700,7 @@ components: Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 javaEnabled: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: summary: Successful card payment with 3D Secure redirect authentication @@ -14884,7 +14731,7 @@ components: encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 holderName: John Smith - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: summary: Successful payment with 3D Secure 2 native authentication, using encrypted @@ -14915,7 +14762,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -14944,7 +14791,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -14999,7 +14846,7 @@ components: encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments @@ -15019,7 +14866,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15048,7 +14895,7 @@ components: paymentMethod: type: paywithgoogle googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15059,7 +14906,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15134,7 +14981,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15148,7 +14995,7 @@ components: recurringDetailReference: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized payment @@ -15350,7 +15197,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15369,7 +15216,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39600 @@ -15458,7 +15305,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15485,7 +15332,7 @@ components: holderName: John Smith cvc: '737' shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT storePaymentMethod: true shopperInteraction: Ecommerce diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 6eeeaaa..a39f6b8 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -5859,7 +5859,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -5889,7 +5889,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6374,23 +6374,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6763,30 +6746,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8051,7 +8010,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8289,7 +8247,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8308,7 +8266,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8509,7 +8467,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8528,7 +8486,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8922,7 +8880,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8937,7 +8895,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9027,9 +8985,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9462,14 +9418,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9552,7 +9506,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10066,52 +10020,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10589,6 +10497,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11471,6 +11389,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12396,7 +12315,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -12510,7 +12429,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -12541,7 +12460,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -13204,78 +13123,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -14780,7 +14627,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication @@ -14820,8 +14667,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful card payment with 3D Secure 2 native authentication @@ -14861,7 +14708,7 @@ components: Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 javaEnabled: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: summary: Successful card payment with 3D Secure redirect authentication @@ -14892,7 +14739,7 @@ components: encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 holderName: John Smith - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: summary: Successful payment with 3D Secure 2 native authentication, using encrypted @@ -14923,7 +14770,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -14952,7 +14799,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -15007,7 +14854,7 @@ components: encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments @@ -15027,7 +14874,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15056,7 +14903,7 @@ components: paymentMethod: type: paywithgoogle googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15067,7 +14914,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15142,7 +14989,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15156,7 +15003,7 @@ components: recurringDetailReference: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized payment @@ -15358,7 +15205,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15377,7 +15224,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39600 @@ -15466,7 +15313,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15493,7 +15340,7 @@ components: holderName: John Smith cvc: '737' shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT storePaymentMethod: true shopperInteraction: Ecommerce diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index 90b87ef..092ead2 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -6040,7 +6040,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6070,7 +6070,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6560,23 +6560,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -6949,30 +6932,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8237,7 +8196,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -8446,7 +8404,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8465,7 +8423,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8692,7 +8650,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8711,7 +8669,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9131,7 +9089,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9146,7 +9104,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9236,9 +9194,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -9671,14 +9627,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -9761,7 +9715,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -10243,60 +10197,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - iban: - x-addedInVersion: '67' - description: The IBAN of the bank account. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - ownerName: - x-addedInVersion: '67' - description: The name of the bank account holder. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -10751,6 +10651,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -11641,6 +11551,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -12677,7 +12588,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -12831,7 +12742,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -12864,7 +12775,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationCampaignId: DONATION_CAMPAIGN_ID - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-donations-donations-with-campaigns-200: summary: Successful donation to a donation campaign @@ -12893,7 +12804,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -13556,78 +13467,6 @@ components: type: text name: DOKU wallet type: doku_wallet - - details: - - items: - - id: '66' - name: Bank Nowy BFG S.A. - - id: '92' - name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" - - id: '11' - name: Bank transfer / postal - - id: '74' - name: "Banki Sp\xF3\u0142dzielcze" - - id: '73' - name: BLIK - - id: '90' - name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" - - id: '59' - name: CinkciarzPAY - - id: '87' - name: Credit Agricole PBL - - id: '83' - name: EnveloBank - - id: '76' - name: Getin Bank PBL - - id: '81' - name: Idea Cloud - - id: '7' - name: ING Corporate customers - - id: '93' - name: Kasa Stefczyka - - id: '44' - name: "Millennium - P\u0142atno\u015Bci Internetowe" - - id: '10' - name: Millennium Corporate customers - - id: '68' - name: mRaty - - id: '1' - name: mTransfer - - id: '91' - name: Nest Bank - - id: '80' - name: Noble Pay - - id: '50' - name: Pay Way Toyota Bank - - id: '45' - name: Pay with Alior Bank - - id: '36' - name: Pekao24Przelew - - id: '70' - name: Pocztowy24 - - id: '6' - name: Przelew24 - - id: '46' - name: "P\u0142ac\u0119 z Citi Handlowy" - - id: '38' - name: "P\u0142ac\u0119 z ING" - - id: '2' - name: "P\u0142ac\u0119 z Inteligo" - - id: '4' - name: "P\u0142ac\u0119 z iPKO" - - id: '75' - name: "P\u0142ac\u0119 z Plus Bank" - - id: '51' - name: "P\u0142a\u0107 z BO\u015A" - - id: '55' - name: Raty z Alior Bankiem PLN - - id: '89' - name: Santander - - id: '52' - name: SkyCash - key: issuer - type: select - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -15132,7 +14971,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication, using encrypted @@ -15171,8 +15010,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication @@ -15198,7 +15037,7 @@ components: screenWidth: 3000 timeZoneOffset: 5 language: en - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: summary: Make a card payment @@ -15214,7 +15053,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -15244,7 +15083,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -15295,7 +15134,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-SF-200: summary: Card details tokenized for one-off payments, using encrypted card details @@ -15333,7 +15172,7 @@ components: shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile storePaymentMethod: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -15363,7 +15202,7 @@ components: paymentMethod: type: googlepay googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -15374,7 +15213,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -15447,7 +15286,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -15461,7 +15300,7 @@ components: storedPaymentMethodId: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: CardOnFile @@ -15665,7 +15504,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -15684,7 +15523,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39600 @@ -15773,7 +15612,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -15803,7 +15642,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-subscription-first-transaction-200: summary: Card details tokenized for a subscription diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index c218c26..4ad08a1 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -4702,10 +4702,11 @@ components: description: "The `localizedShopperStatement` field lets you use dynamic\ \ values for your shopper statement in a local character set.\nIf not\ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\ - \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\ - \ and Mastercard payments in Japan using Japanese cards. This character\ - \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\ - \ special characters. \n* Half-width or full-width characters." + \ is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character\ + \ set for Visa, Mastercard and JCB payments in Japan using Japanese cards.\ + \ This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital\ + \ letters, numbers and special characters. \n* Half-width or full-width\ + \ characters." type: object mcc: x-addedInVersion: '12' @@ -6080,7 +6081,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6099,7 +6100,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6476,7 +6477,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6495,7 +6496,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7236,7 +7237,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7266,7 +7267,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7780,27 +7781,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -8197,34 +8177,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -9604,7 +9556,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -9813,7 +9764,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9832,7 +9783,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10074,7 +10025,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10093,7 +10044,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10550,7 +10501,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10565,7 +10516,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10655,9 +10606,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -11111,14 +11060,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -11205,7 +11152,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -11691,69 +11638,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The year the card expires, for example **2022**. - type: string - holderName: - description: The unique payment method code. - type: string - iban: - x-addedInVersion: '67' - description: The IBAN of the bank account. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - networkTxReference: - x-addedInVersion: '68' - description: 'Returned in the response if you are not tokenizing with Adyen - and are using the Merchant-initiated transactions (MIT) framework from - Mastercard or Visa. - - - This contains either the Mastercard Trace ID or the Visa Transaction ID.' - type: string - ownerName: - x-addedInVersion: '67' - description: The name of the bank account holder. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -12220,6 +12104,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -13180,6 +13074,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -14593,7 +14488,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -14753,7 +14648,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -14786,7 +14681,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationCampaignId: DONATION_CAMPAIGN_ID - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-donations-donations-with-campaigns-200: summary: Successful donation to a donation campaign @@ -14815,7 +14710,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -14855,7 +14750,7 @@ components: currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT post-orders-basic-200: - summary: List of available payment methods + summary: Order created value: pspReference: '8616178914061985' resultCode: Success @@ -15143,8 +15038,6 @@ components: type: doku_permata_lite_atm - name: DOKU wallet type: doku_wallet - - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -15914,7 +15807,7 @@ components: paymentMethod: type: applepay applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web: summary: Make a card payment with 3D Secure 2 native authentication, using encrypted @@ -15953,8 +15846,8 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com - returnUrl: https://your-company.com/checkout/ + origin: https://your-company.example.com + returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct: summary: Make card payment with 3D Secure redirect authentication @@ -15980,7 +15873,7 @@ components: screenWidth: 3000 timeZoneOffset: 5 language: en - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: summary: Make a card payment @@ -15996,7 +15889,7 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment @@ -16026,7 +15919,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -16077,7 +15970,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-SF-200: summary: Card details tokenized for one-off payments, using encrypted card details @@ -16115,7 +16008,7 @@ components: shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile storePaymentMethod: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -16145,7 +16038,7 @@ components: paymentMethod: type: googlepay googlePayToken: ==Payload as retrieved from Google Pay response== - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment @@ -16156,7 +16049,7 @@ components: reference: Your order number paymentMethod: type: ideal - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-ideal-200: summary: Successful iDEAL payment @@ -16229,7 +16122,7 @@ components: storedPaymentMethodId: '8416038790273850' cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-oneclick-securedfields: summary: Make a one-off payment with a token and CVV, using encrypted card details @@ -16243,7 +16136,7 @@ components: storedPaymentMethodId: '8416038790273850' encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: CardOnFile @@ -16447,7 +16340,7 @@ components: type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription @@ -16466,7 +16359,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -16493,7 +16386,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... platformChargebackLogic: behavior: deductFromOneBalanceAccount targetAccount: BA00000000000000000000001 @@ -16552,7 +16445,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: Subscription - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-subscription-first-transaction-200: summary: Card details tokenized for a subscription @@ -16662,7 +16555,7 @@ components: amount: value: 100 currency: EUR - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. reference: YOUR_PAYMENT_REFERENCE countryCode: NL post-sessions-00.success-201: @@ -16677,7 +16570,7 @@ components: id: CS451F2AB1ED897A94 merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_PAYMENT_REFERENCE - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. sessionData: Ab02b4c0!BQABAgBfYI29... post-sessions-01.klarna: summary: Create a payment session including Klarna fields @@ -16794,7 +16687,7 @@ components: value: 100 currency: EUR shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. reference: YOUR_PAYMENT_REFERENCE countryCode: NL storePaymentMethod: true @@ -16814,7 +16707,7 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT recurringProcessingModel: CardOnFile reference: YOUR_PAYMENT_REFERENCE - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. shopperInteraction: Ecommerce storePaymentMethod: true sessionData: Ab02b4c0!BQABAgBfYI29... @@ -16826,7 +16719,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39200 @@ -16855,7 +16748,7 @@ components: id: CSFCBC80570618EF2C merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_ORDER_NUMBER - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... shopperLocale: en-US splits: - account: BA00000000000000000000001 diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 4ed4ec1..482664a 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -4744,10 +4744,11 @@ components: description: "The `localizedShopperStatement` field lets you use dynamic\ \ values for your shopper statement in a local character set.\nIf not\ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\ - \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\ - \ and Mastercard payments in Japan using Japanese cards. This character\ - \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\ - \ special characters. \n* Half-width or full-width characters." + \ is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character\ + \ set for Visa, Mastercard and JCB payments in Japan using Japanese cards.\ + \ This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital\ + \ letters, numbers and special characters. \n* Half-width or full-width\ + \ characters." type: object mcc: x-addedInVersion: '12' @@ -6151,7 +6152,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6174,7 +6175,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6571,7 +6572,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6594,7 +6595,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7360,7 +7361,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7394,7 +7395,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7911,27 +7912,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -8324,34 +8304,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -9731,7 +9683,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -9952,7 +9903,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -9971,7 +9922,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10253,7 +10204,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10272,7 +10223,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10769,7 +10720,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10784,7 +10735,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10874,9 +10825,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -11334,14 +11283,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -11428,7 +11375,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -11923,70 +11870,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The last two digits of the year the card expires. For example, - **22** for the year 2022. - type: string - holderName: - description: The unique payment method code. - type: string - iban: - x-addedInVersion: '67' - description: The IBAN of the bank account. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - networkTxReference: - x-addedInVersion: '68' - description: 'Returned in the response if you are not tokenizing with Adyen - and are using the Merchant-initiated transactions (MIT) framework from - Mastercard or Visa. - - - This contains either the Mastercard Trace ID or the Visa Transaction ID.' - type: string - ownerName: - x-addedInVersion: '67' - description: The name of the bank account holder. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -12453,6 +12336,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -13426,6 +13319,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -14890,7 +14784,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -15050,7 +14944,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -15083,7 +14977,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationCampaignId: DONATION_CAMPAIGN_ID - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-donations-donations-with-campaigns-200: summary: Successful donation to a donation campaign @@ -15112,7 +15006,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -15152,7 +15046,7 @@ components: currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT post-orders-basic-200: - summary: List of available payment methods + summary: Order created value: pspReference: '8616178914061985' resultCode: Success @@ -15440,8 +15334,6 @@ components: type: doku_permata_lite_atm - name: DOKU wallet type: doku_wallet - - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking @@ -16251,7 +16143,7 @@ components: timeZoneOffset: 0 javaEnabled: true channel: Web - origin: https://your-company.com + origin: https://your-company.example.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct: @@ -16278,7 +16170,7 @@ components: screenWidth: 3000 timeZoneOffset: 5 language: en - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: summary: Make a card payment @@ -16324,7 +16216,7 @@ components: encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment using encrypted card details @@ -16375,7 +16267,7 @@ components: storePaymentMethod: true shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-SF-200: summary: Card details tokenized for one-off payments, using encrypted card details @@ -16413,7 +16305,7 @@ components: shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile storePaymentMethod: true - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-raw-200: summary: Card details tokenized for one-off payments @@ -16764,7 +16656,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... platformChargebackLogic: behavior: deductFromOneBalanceAccount targetAccount: BA00000000000000000000001 @@ -16858,7 +16750,7 @@ components: currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 6000 @@ -16998,7 +16890,7 @@ components: amount: value: 100 currency: EUR - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. reference: YOUR_PAYMENT_REFERENCE countryCode: NL post-sessions-00.success-201: @@ -17013,7 +16905,7 @@ components: id: CS451F2AB1ED897A94 merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_PAYMENT_REFERENCE - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. sessionData: Ab02b4c0!BQABAgBfYI29... post-sessions-01.klarna: summary: Create a payment session including Klarna fields @@ -17130,7 +17022,7 @@ components: value: 100 currency: EUR shopperReference: YOUR_SHOPPER_REFERENCE - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. reference: YOUR_PAYMENT_REFERENCE countryCode: NL storePaymentMethod: true @@ -17150,7 +17042,7 @@ components: merchantAccount: YOUR_MERCHANT_ACCOUNT recurringProcessingModel: CardOnFile reference: YOUR_PAYMENT_REFERENCE - returnUrl: https://your-company.com/checkout?shopperOrder=12xy.. + returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. shopperInteraction: Ecommerce storePaymentMethod: true sessionData: Ab02b4c0!BQABAgBfYI29... @@ -17162,7 +17054,7 @@ components: currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... splits: - amount: value: 39200 @@ -17191,7 +17083,7 @@ components: id: CSFCBC80570618EF2C merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_ORDER_NUMBER - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... shopperLocale: en-US splits: - account: BA00000000000000000000001 diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index 63a6c6e..a099d6e 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -4366,6 +4366,153 @@ components: - type title: Afterpay type: object + Agency: + additionalProperties: false + properties: + invoiceNumber: + description: 'The reference number for the invoice, issued by the agency. + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 6 characters' + type: string + planName: + description: 'The two-letter agency plan identifier. + + * Encoding: ASCII + + * minLength: 2 characters + + * maxLength: 2 characters' + type: string + type: object + Airline: + additionalProperties: false + properties: + agency: + $ref: '#/components/schemas/Agency' + boardingFee: + description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + * Encoding: Numeric + + * minLength: 1 character + + * maxLength: 11 characters' + format: int64 + type: integer + code: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 3-digit accounting code (PAX) that identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 characters + + * maxLength: 3 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + computerizedReservationSystem: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Encoding: ASCII + + * minLength: 4 characters + + * maxLength: 4 characters' + type: string + customerReferenceNumber: + description: 'The alphanumeric customer reference number. + + * Encoding: ASCII + + * maxLength: 20 characters + + * If you send more than 20 characters, the customer reference number is + truncated + + * Must not start with a space or be all spaces.' + type: string + designatorCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 2-letter accounting code (PAX) that identifies the carrier. + + * Encoding: ASCII + + * Example: KLM = KL + + * minLength: 2 characters + + * maxLength: 2 characters + + * Must not start with a space or be all spaces.' + type: string + documentType: + description: 'A code that identifies the type of item bought. The description + of the code can appear on credit card statements. + + * Encoding: ASCII + + * Example: Passenger ticket = 01 + + * minLength: 2 characters + + * maxLength: 2 characters' + type: string + flightDate: + description: 'The flight departure date. Time is optional. + + * Format for date only: `yyyy-MM-dd` + + * Format for date and time: `yyyy-MM-ddTHH:mm` + + * Use local time of departure airport. + + * minLength: 10 characters + + * maxLength: 16 characters' + format: date-time + type: string + legs: + items: + $ref: '#/components/schemas/Leg' + type: array + passengerName: + description: 'The passenger''s name, initials, and title. + + * Format: last name + first name or initials + title + + * Example: *FLYER / MARY MS* + + * minLength: 1 character + + * maxLength: 20 characters + + * If you send more than 20 characters, the name is truncated + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + passengers: + items: + $ref: '#/components/schemas/Passenger' + type: array + ticket: + $ref: '#/components/schemas/Ticket' + travelAgency: + $ref: '#/components/schemas/TravelAgency' + required: + - passengerName + type: object AmazonPayDetails: additionalProperties: false properties: @@ -4827,10 +4974,11 @@ components: description: "The `localizedShopperStatement` field lets you use dynamic\ \ values for your shopper statement in a local character set.\nIf not\ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\ - \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\ - \ and Mastercard payments in Japan using Japanese cards. This character\ - \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\ - \ special characters. \n* Half-width or full-width characters." + \ is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character\ + \ set for Visa, Mastercard and JCB payments in Japan using Japanese cards.\ + \ This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital\ + \ letters, numbers and special characters. \n* Half-width or full-width\ + \ characters." type: object mcc: x-addedInVersion: '12' @@ -6234,7 +6382,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6257,7 +6405,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6672,7 +6820,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6695,7 +6843,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7491,7 +7639,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7525,7 +7673,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -8062,27 +8210,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -8233,6 +8360,15 @@ components: - pspReference - orderData type: object + EnhancedSchemeData: + additionalProperties: false + properties: + airline: + description: '[Airline enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/airline/) + that may be required for processing the transaction and/or for interchange + savings.' + $ref: '#/components/schemas/Airline' + type: object ExternalPlatform: additionalProperties: false properties: @@ -8475,34 +8611,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8863,6 +8971,127 @@ components: - type title: Klarna type: object + Leg: + additionalProperties: false + properties: + carrierCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 2-letter accounting code (PAX) that identifies the carrier. + + This field is required if the airline data includes leg details. + + * Example: KLM = KL + + * minLength: 2 characters + + * maxLength: 2 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + classOfTravel: + description: "A one-letter travel class identifier.\n The following are\ + \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ + * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ + * maxLength: 1 character\n* Must not start with a space or be all spaces.\n\ + * Must not be all zeros." + type: string + dateOfTravel: + description: 'Date and time of travel in format `yyyy-MM-ddTHH:mm`. + + * Use local time of departure airport. + + * minLength: 16 characters + + * maxLength: 16 characters' + format: date-time + type: string + departureAirportCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + three-letter airport code of the departure airport. + + This field is required if the airline data includes leg details. + + + * Encoding: ASCII + + * Example: Amsterdam = AMS + + * minLength: 3 characters + + * maxLength: 3 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + departureTax: + description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) + charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + * Encoding: Numeric + + * minLength: 1 + + * maxLength: 11 + + * Must not be all zeros.' + format: int64 + type: integer + destinationAirportCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 3-letter airport code of the destination airport. + + This field is required if the airline data includes leg details. + + * Example: Amsterdam = AMS + + * Encoding: ASCII + + * minLength: 3 characters + + * maxLength: 3 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + fareBasisCode: + description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), + alphanumeric. + + * minLength: 1 character + + * maxLength: 6 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + flightNumber: + description: 'The flight identifier. + + * minLength: 1 character + + * maxLength: 5 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + stopOverCode: + description: 'A one-letter code that indicates whether the passenger is + entitled to make a stopover. Can be a space, O if the passenger is entitled + to make a stopover, or X if they are not. + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 1 character' + type: string + type: object LineItem: additionalProperties: false properties: @@ -9287,6 +9516,55 @@ components: type: string title: Open Invoice type: object + Passenger: + additionalProperties: false + properties: + dateOfBirth: + description: 'The passenger''s date of birth. + + * Format `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + format: date + type: string + firstName: + description: 'The passenger''s first name. + + > This field is required if the airline data includes passenger details + or leg details. + + * Encoding: ASCII' + type: string + lastName: + description: 'The passenger''s last name. + + > This field is required if the airline data includes passenger details + or leg details. + + * Encoding: ASCII' + type: string + phoneNumber: + description: 'The passenger''s phone number, including country code. This + is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * Encoding: ASCII + + * minLength: 3 characters + + * maxLength: 30 characters' + type: string + travellerType: + description: 'The IATA passenger type code (PTC). + + * Encoding: ASCII + + * minLength: 3 characters + + * maxLength: 6 characters' + type: string + type: object PayByBankAISDirectDebitDetails: additionalProperties: false properties: @@ -9737,6 +10015,11 @@ components: description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' + enhancedSchemeData: + x-addedInVersion: '70' + description: Enhanced scheme data that may be required for processing the + payment. For example, airline information. + $ref: '#/components/schemas/EnhancedSchemeData' lineItems: description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). @@ -9968,7 +10251,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -10189,7 +10471,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10208,7 +10490,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10490,7 +10772,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10509,7 +10791,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -11006,7 +11288,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -11021,7 +11303,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -11111,9 +11393,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -11454,6 +11734,12 @@ components: where the shopper is not present, such as subscription or automatic top-up payments. type: boolean + enhancedSchemeData: + x-addedInVersion: '70' + description: '[Enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/) + that may be required for processing the payment and/or interchange savings + can apply.' + $ref: '#/components/schemas/EnhancedSchemeData' entityType: description: The type of the entity the payment is processed for. enum: @@ -11594,14 +11880,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -11688,7 +11972,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -12183,81 +12467,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The last two digits of the year the card expires. For example, - **22** for the year 2022. - type: string - holderName: - description: The unique payment method code. - type: string - iban: - x-addedInVersion: '67' - description: The IBAN of the bank account. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - label: - x-addedInVersion: '70' - description: "The shopper\u2019s issuer account label" - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - networkTxReference: - x-addedInVersion: '68' - description: 'Returned in the response if you are not tokenizing with Adyen - and are using the Merchant-initiated transactions (MIT) framework from - Mastercard or Visa. - - - This contains either the Mastercard Trace ID or the Visa Transaction ID.' - type: string - ownerName: - x-addedInVersion: '67' - description: The name of the bank account holder. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedRecurringProcessingModels: - x-addedInVersion: '70' - description: The supported recurring processing models for this stored payment - method. - items: - type: string - type: array - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -12724,6 +12933,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -13708,6 +13927,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -14856,6 +15076,70 @@ components: format: byte type: string type: object + Ticket: + additionalProperties: false + properties: + issueAddress: + description: 'The address of the organization that issued the ticket. + + * minLength: 0 characters + + * maxLength: 16 characters' + type: string + issueDate: + description: 'The date that the ticket was issued to the passenger. + + * minLength: 10 characters + + * maxLength: 10 characters + + * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd' + format: date + type: string + number: + description: 'The ticket''s unique identifier. + + * minLength: 1 character + + * maxLength: 15 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + type: object + TravelAgency: + additionalProperties: false + properties: + code: + description: 'The unique identifier from IATA or ARC for the travel agency + that issues the ticket. + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 8 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + name: + description: 'The name of the travel agency. + + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 25 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + type: object TwintDetails: additionalProperties: false properties: @@ -15196,7 +15480,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -15377,7 +15661,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -15410,7 +15694,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationCampaignId: DONATION_CAMPAIGN_ID - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-donations-donations-with-campaigns-200: summary: Successful donation to a donation campaign @@ -15439,7 +15723,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -15479,7 +15763,7 @@ components: currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT post-orders-basic-200: - summary: List of available payment methods + summary: Order created value: pspReference: '8616178914061985' resultCode: Success @@ -15767,8 +16051,6 @@ components: type: doku_permata_lite_atm - name: DOKU wallet type: doku_wallet - - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking diff --git a/yaml/CheckoutService-v71.yaml b/yaml/CheckoutService-v71.yaml index 5d1f18c..3313414 100644 --- a/yaml/CheckoutService-v71.yaml +++ b/yaml/CheckoutService-v71.yaml @@ -4366,6 +4366,153 @@ components: - type title: Afterpay type: object + Agency: + additionalProperties: false + properties: + invoiceNumber: + description: 'The reference number for the invoice, issued by the agency. + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 6 characters' + type: string + planName: + description: 'The two-letter agency plan identifier. + + * Encoding: ASCII + + * minLength: 2 characters + + * maxLength: 2 characters' + type: string + type: object + Airline: + additionalProperties: false + properties: + agency: + $ref: '#/components/schemas/Agency' + boardingFee: + description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + * Encoding: Numeric + + * minLength: 1 character + + * maxLength: 11 characters' + format: int64 + type: integer + code: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 3-digit accounting code (PAX) that identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 characters + + * maxLength: 3 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + computerizedReservationSystem: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Encoding: ASCII + + * minLength: 4 characters + + * maxLength: 4 characters' + type: string + customerReferenceNumber: + description: 'The alphanumeric customer reference number. + + * Encoding: ASCII + + * maxLength: 20 characters + + * If you send more than 20 characters, the customer reference number is + truncated + + * Must not start with a space or be all spaces.' + type: string + designatorCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 2-letter accounting code (PAX) that identifies the carrier. + + * Encoding: ASCII + + * Example: KLM = KL + + * minLength: 2 characters + + * maxLength: 2 characters + + * Must not start with a space or be all spaces.' + type: string + documentType: + description: 'A code that identifies the type of item bought. The description + of the code can appear on credit card statements. + + * Encoding: ASCII + + * Example: Passenger ticket = 01 + + * minLength: 2 characters + + * maxLength: 2 characters' + type: string + flightDate: + description: 'The flight departure date. Time is optional. + + * Format for date only: `yyyy-MM-dd` + + * Format for date and time: `yyyy-MM-ddTHH:mm` + + * Use local time of departure airport. + + * minLength: 10 characters + + * maxLength: 16 characters' + format: date-time + type: string + legs: + items: + $ref: '#/components/schemas/Leg' + type: array + passengerName: + description: 'The passenger''s name, initials, and title. + + * Format: last name + first name or initials + title + + * Example: *FLYER / MARY MS* + + * minLength: 1 character + + * maxLength: 20 characters + + * If you send more than 20 characters, the name is truncated + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + passengers: + items: + $ref: '#/components/schemas/Passenger' + type: array + ticket: + $ref: '#/components/schemas/Ticket' + travelAgency: + $ref: '#/components/schemas/TravelAgency' + required: + - passengerName + type: object AmazonPayDetails: additionalProperties: false properties: @@ -4827,10 +4974,11 @@ components: description: "The `localizedShopperStatement` field lets you use dynamic\ \ values for your shopper statement in a local character set.\nIf not\ \ supplied, left empty, or for cross-border transactions, **shopperStatement**\ - \ is used.\n\nAdyen currently supports the ja-Kana character set for Visa\ - \ and Mastercard payments in Japan using Japanese cards. This character\ - \ set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and\ - \ special characters. \n* Half-width or full-width characters." + \ is used.\n\nAdyen currently supports the ja-Kana and ja-Hani character\ + \ set for Visa, Mastercard and JCB payments in Japan using Japanese cards.\ + \ This character set supports:\n\n* UTF-8 based Katakana, Kanji, capital\ + \ letters, numbers and special characters. \n* Half-width or full-width\ + \ characters." type: object mcc: x-addedInVersion: '12' @@ -6234,7 +6382,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6257,7 +6405,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6672,7 +6820,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -6695,7 +6843,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -7860,27 +8008,6 @@ components: - refused type: string type: object - DotpayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - issuer: - description: The Dotpay issuer value of the shopper's selected bank. Set - this to an **id** of a Dotpay issuer to preselect it. - type: string - type: - default: dotpay - description: '**dotpay**' - enum: - - dotpay - type: string - required: - - issuer - title: Dotpay - type: object DragonpayDetails: additionalProperties: false properties: @@ -8031,6 +8158,15 @@ components: - pspReference - orderData type: object + EnhancedSchemeData: + additionalProperties: false + properties: + airline: + description: '[Airline enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/airline/) + that may be required for processing the transaction and/or for interchange + savings.' + $ref: '#/components/schemas/Airline' + type: object ExternalPlatform: additionalProperties: false properties: @@ -8273,34 +8409,6 @@ components: - issuer title: Stored Payment Method type: object - GiropayDetails: - additionalProperties: false - properties: - checkoutAttemptId: - x-addedInVersion: '68' - description: The checkout attempt identifier. - type: string - recurringDetailReference: - deprecated: true - x-deprecatedInVersion: '49' - x-deprecatedMessage: Use `storedPaymentMethodId` instead. - description: This is the `recurringDetailReference` returned in the response - when you created the token. - type: string - storedPaymentMethodId: - x-addedInVersion: '49' - description: This is the `recurringDetailReference` returned in the response - when you created the token. - maxLength: 64 - type: string - type: - default: giropay - description: '**giropay**' - enum: - - giropay - type: string - title: Giropay - type: object GooglePayDetails: additionalProperties: false properties: @@ -8661,6 +8769,127 @@ components: - type title: Klarna type: object + Leg: + additionalProperties: false + properties: + carrierCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 2-letter accounting code (PAX) that identifies the carrier. + + This field is required if the airline data includes leg details. + + * Example: KLM = KL + + * minLength: 2 characters + + * maxLength: 2 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + classOfTravel: + description: "A one-letter travel class identifier.\n The following are\ + \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ + * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ + * maxLength: 1 character\n* Must not start with a space or be all spaces.\n\ + * Must not be all zeros." + type: string + dateOfTravel: + description: 'Date and time of travel in format `yyyy-MM-ddTHH:mm`. + + * Use local time of departure airport. + + * minLength: 16 characters + + * maxLength: 16 characters' + format: date-time + type: string + departureAirportCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + three-letter airport code of the departure airport. + + This field is required if the airline data includes leg details. + + + * Encoding: ASCII + + * Example: Amsterdam = AMS + + * minLength: 3 characters + + * maxLength: 3 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + departureTax: + description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) + charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + * Encoding: Numeric + + * minLength: 1 + + * maxLength: 11 + + * Must not be all zeros.' + format: int64 + type: integer + destinationAirportCode: + description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) + 3-letter airport code of the destination airport. + + This field is required if the airline data includes leg details. + + * Example: Amsterdam = AMS + + * Encoding: ASCII + + * minLength: 3 characters + + * maxLength: 3 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + fareBasisCode: + description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), + alphanumeric. + + * minLength: 1 character + + * maxLength: 6 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + flightNumber: + description: 'The flight identifier. + + * minLength: 1 character + + * maxLength: 5 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + stopOverCode: + description: 'A one-letter code that indicates whether the passenger is + entitled to make a stopover. Can be a space, O if the passenger is entitled + to make a stopover, or X if they are not. + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 1 character' + type: string + type: object LineItem: additionalProperties: false properties: @@ -9085,6 +9314,55 @@ components: type: string title: Open Invoice type: object + Passenger: + additionalProperties: false + properties: + dateOfBirth: + description: 'The passenger''s date of birth. + + * Format `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + format: date + type: string + firstName: + description: 'The passenger''s first name. + + > This field is required if the airline data includes passenger details + or leg details. + + * Encoding: ASCII' + type: string + lastName: + description: 'The passenger''s last name. + + > This field is required if the airline data includes passenger details + or leg details. + + * Encoding: ASCII' + type: string + phoneNumber: + description: 'The passenger''s phone number, including country code. This + is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * Encoding: ASCII + + * minLength: 3 characters + + * maxLength: 30 characters' + type: string + travellerType: + description: 'The IATA passenger type code (PTC). + + * Encoding: ASCII + + * minLength: 3 characters + + * maxLength: 6 characters' + type: string + type: object PayByBankAISDirectDebitDetails: additionalProperties: false properties: @@ -9545,6 +9823,11 @@ components: description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' + enhancedSchemeData: + x-addedInVersion: '70' + description: Enhanced scheme data that may be required for processing the + payment. For example, airline information. + $ref: '#/components/schemas/EnhancedSchemeData' lineItems: description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). @@ -9776,7 +10059,6 @@ components: - directEbanking - boletobancario - neteller - - paysafecard - cashticket - ikano - karenmillen @@ -9997,7 +10279,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10016,7 +10298,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10300,7 +10582,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10319,7 +10601,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10818,7 +11100,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"allowedPaymentMethods":["ideal","giropay"]`' + Example: `"allowedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10833,7 +11115,7 @@ components: refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). - Example: `"blockedPaymentMethods":["ideal","giropay"]`' + Example: `"blockedPaymentMethods":["ideal","applepay"]`' items: type: string type: array @@ -10923,9 +11205,7 @@ components: x-addedInVersion: '49' description: List of all stored payment methods. items: - oneOf: - - $ref: '#/components/schemas/PixStoredPaymentMethod' - - $ref: '#/components/schemas/StoredPaymentMethod' + $ref: '#/components/schemas/StoredPaymentMethod' type: array type: object PaymentRefundRequest: @@ -11266,6 +11546,12 @@ components: where the shopper is not present, such as subscription or automatic top-up payments. type: boolean + enhancedSchemeData: + x-addedInVersion: '70' + description: '[Enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/) + that may be required for processing the payment and/or interchange savings + can apply.' + $ref: '#/components/schemas/EnhancedSchemeData' entityType: description: The type of the entity the payment is processed for. enum: @@ -11406,14 +11692,12 @@ components: - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DokuDetails' - - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' @@ -11500,7 +11784,7 @@ components: description: "The URL to return to in case of a redirection.\nThe format\ \ depends on the channel. \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 example, shopper ID or order reference number.\nExample: `https://your-company.example.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).\n\ Example: `my-app://`\n* For Android, use a custom URL handled by an Activity\ @@ -11995,81 +12279,6 @@ components: type: string title: pixRecurring type: object - PixStoredPaymentMethod: - additionalProperties: false - properties: - bankAccountNumber: - description: The bank account number (without separators). - type: string - bankLocationId: - description: The location id of the bank. The field value is `nil` in most - cases. - type: string - brand: - description: The brand of the card. - type: string - expiryMonth: - description: The two-digit month when the card expires - type: string - expiryYear: - description: The last two digits of the year the card expires. For example, - **22** for the year 2022. - type: string - holderName: - description: The unique payment method code. - type: string - iban: - x-addedInVersion: '67' - description: The IBAN of the bank account. - type: string - id: - description: A unique identifier of this stored payment method. - type: string - label: - x-addedInVersion: '70' - description: "The shopper\u2019s issuer account label" - type: string - lastFour: - description: The last four digits of the PAN. - type: string - name: - description: The display name of the stored payment method. - type: string - networkTxReference: - x-addedInVersion: '68' - description: 'Returned in the response if you are not tokenizing with Adyen - and are using the Merchant-initiated transactions (MIT) framework from - Mastercard or Visa. - - - This contains either the Mastercard Trace ID or the Visa Transaction ID.' - type: string - ownerName: - x-addedInVersion: '67' - description: The name of the bank account holder. - type: string - shopperEmail: - description: "The shopper\u2019s email address." - type: string - supportedRecurringProcessingModels: - x-addedInVersion: '70' - description: The supported recurring processing models for this stored payment - method. - items: - type: string - type: array - supportedShopperInteractions: - description: The supported shopper interactions for this stored payment - method. - items: - type: string - type: array - type: - description: The type of payment method. - enum: - - pix - type: string - type: object PlatformChargebackLogic: additionalProperties: false properties: @@ -12536,6 +12745,16 @@ components: - GREEN - FRAUD type: string + fraudRiskLevel: + description: The risk level of the payment as determined by the FDM machine + learning model. + enum: + - Very low + - Low + - Medium + - High + - Very high + type: string fundingSource: description: 'Information regarding the funding type of the card. The possible return values are: @@ -13520,6 +13739,7 @@ components: - dana - kakaopay - truemoney + - paysafecard type: string title: Stored Payment Method type: object @@ -14668,6 +14888,70 @@ components: format: byte type: string type: object + Ticket: + additionalProperties: false + properties: + issueAddress: + description: 'The address of the organization that issued the ticket. + + * minLength: 0 characters + + * maxLength: 16 characters' + type: string + issueDate: + description: 'The date that the ticket was issued to the passenger. + + * minLength: 10 characters + + * maxLength: 10 characters + + * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd' + format: date + type: string + number: + description: 'The ticket''s unique identifier. + + * minLength: 1 character + + * maxLength: 15 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + type: object + TravelAgency: + additionalProperties: false + properties: + code: + description: 'The unique identifier from IATA or ARC for the travel agency + that issues the ticket. + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 8 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + name: + description: 'The name of the travel agency. + + + * Encoding: ASCII + + * minLength: 1 character + + * maxLength: 25 characters + + * Must not start with a space or be all spaces. + + * Must not be all zeros.' + type: string + type: object TwintDetails: additionalProperties: false properties: @@ -15008,7 +15292,7 @@ components: errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: - summary: List of available payment methods + summary: Payment link details value: amount: currency: EUR @@ -15189,7 +15473,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-200: @@ -15222,7 +15506,7 @@ components: donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationCampaignId: DONATION_CAMPAIGN_ID - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-donations-donations-with-campaigns-200: summary: Successful donation to a donation campaign @@ -15251,7 +15535,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '7219687191761347' - returnUrl: https://your-company.com/... + returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth @@ -15291,7 +15575,7 @@ components: currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT post-orders-basic-200: - summary: List of available payment methods + summary: Order created value: pspReference: '8616178914061985' resultCode: Success @@ -15579,8 +15863,6 @@ components: type: doku_permata_lite_atm - name: DOKU wallet type: doku_wallet - - name: Local Polish Payment Methods - type: dotpay - name: Dragonpay Prepaid Credits type: dragonpay_credits - name: Online Banking