diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index 777546f1..5cbf9cd5 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -3267,7 +3267,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3687,7 +3687,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3699,7 +3699,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3715,7 +3715,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5842,7 +5842,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -5858,7 +5858,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6041,7 +6041,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -6287,6 +6287,41 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -8489,7 +8524,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8501,7 +8536,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8964,6 +8999,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -9056,7 +9094,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -9396,7 +9434,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9413,7 +9451,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 2c813390..051c0eba 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -3414,7 +3414,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3834,7 +3834,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3846,7 +3846,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3862,7 +3862,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6090,7 +6090,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6111,7 +6111,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6305,7 +6305,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -6556,6 +6556,41 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -8826,7 +8861,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8838,7 +8873,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9322,6 +9357,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -9414,7 +9452,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -9767,7 +9805,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9789,7 +9827,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index 27579cbf..03b328b7 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -3427,7 +3427,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3847,7 +3847,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3859,7 +3859,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3875,7 +3875,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6103,7 +6103,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6124,7 +6124,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6318,7 +6318,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -6569,6 +6569,41 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -8844,7 +8879,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8856,7 +8891,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9340,6 +9375,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -9432,7 +9470,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -9790,7 +9828,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9812,7 +9850,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 15aceffe..e829f1c9 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -3427,7 +3427,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3847,7 +3847,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3859,7 +3859,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3875,7 +3875,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6103,7 +6103,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6124,7 +6124,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6318,7 +6318,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -6569,6 +6569,41 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "type" : "string" + }, + "recurringDetailReference" : { + "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", + "type" : "string" + }, + "type" : { + "default" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -8844,7 +8879,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8856,7 +8891,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9340,6 +9375,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -9432,7 +9470,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -9790,7 +9828,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9812,7 +9850,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index fcd3bbc3..a777e4b2 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -3436,7 +3436,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3856,7 +3856,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3868,7 +3868,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5763,6 +5763,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5787,10 +5791,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6583,7 +6595,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6604,7 +6616,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6803,7 +6815,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7059,6 +7071,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9459,7 +9515,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9471,7 +9527,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9968,6 +10024,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10060,7 +10119,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10461,7 +10520,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10483,7 +10542,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index d3208ab1..6370c8cd 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5785,6 +5785,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5809,10 +5813,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6605,7 +6617,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6626,7 +6638,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6825,7 +6837,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7087,6 +7099,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9497,7 +9553,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9509,7 +9565,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10006,6 +10062,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10098,7 +10157,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10505,7 +10564,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10527,7 +10586,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index 628738b8..0ce74b97 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5791,6 +5791,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5815,10 +5819,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6611,7 +6623,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6632,7 +6644,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6837,7 +6849,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7099,6 +7111,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9516,7 +9572,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9528,7 +9584,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10037,6 +10093,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10129,7 +10188,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10536,7 +10595,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10558,7 +10617,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 62db454c..03d1f72c 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5791,6 +5791,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5815,10 +5819,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6611,7 +6623,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6632,7 +6644,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6845,7 +6857,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7107,6 +7119,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9529,7 +9585,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9541,7 +9597,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10050,6 +10106,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10142,7 +10201,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10554,7 +10613,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10576,7 +10635,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index 820d15a8..b861b583 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5791,6 +5791,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5815,10 +5819,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6611,7 +6623,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6632,7 +6644,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6845,7 +6857,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7107,6 +7119,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9538,7 +9594,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9550,7 +9606,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10065,6 +10121,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10157,7 +10216,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10569,7 +10628,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10591,7 +10650,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index a76b835e..4250251b 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5791,6 +5791,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5815,10 +5819,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6611,7 +6623,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6632,7 +6644,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6845,7 +6857,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7107,6 +7119,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9588,7 +9644,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9600,7 +9656,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10120,6 +10176,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10212,7 +10271,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10638,7 +10697,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10660,7 +10719,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index 03744f96..53ba35f0 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5805,6 +5805,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5829,10 +5833,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6625,7 +6637,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6646,7 +6658,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6853,7 +6865,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7115,6 +7127,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9586,7 +9642,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9598,7 +9654,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10092,6 +10148,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10184,7 +10243,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10610,7 +10669,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10632,7 +10691,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index fdeac4f5..40f673b6 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -3452,7 +3452,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -3872,7 +3872,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3884,7 +3884,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3900,7 +3900,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5805,6 +5805,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5829,10 +5833,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6625,7 +6637,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6646,7 +6658,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6853,7 +6865,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7115,6 +7127,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9591,7 +9647,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9603,7 +9659,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10097,6 +10153,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10189,7 +10248,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10620,7 +10679,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10642,7 +10701,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index 9b87bf75..6957fa3a 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -489,6 +489,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token" } @@ -512,6 +515,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations-200" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns-200" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token-200" } @@ -3588,7 +3594,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -4008,7 +4014,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -4020,7 +4026,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -4036,7 +4042,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -5963,6 +5969,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -5987,10 +5997,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -6867,7 +6885,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -6888,7 +6906,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -7100,7 +7118,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7362,6 +7380,50 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -9835,7 +9897,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -9847,7 +9909,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10341,6 +10403,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -10433,7 +10498,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -10827,7 +10892,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -10849,7 +10914,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -13716,6 +13781,46 @@ } } }, + "post-donations-donations-with-campaigns" : { + "summary" : "Start a donation transaction for a donation campaign", + "value" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "paymentMethod" : { + "type" : "scheme" + }, + "donationToken" : "YOUR_DONATION_TOKEN", + "donationOriginalPspReference" : "991559660454807J", + "donationCampaignId" : "DONATION_CAMPAIGN_ID", + "returnUrl" : "https://your-company.com/...", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-donations-donations-with-campaigns-200" : { + "summary" : "Example response", + "value" : { + "id" : "UNIQUE_RESOURCE_ID", + "status" : "completed", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "payment" : { + "pspReference" : "8535762347980628", + "resultCode" : "Authorised", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_DONATION_REFERENCE" + } + } + }, "post-donations-donations-with-token" : { "summary" : "Start a donation transaction with a token", "value" : { diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index 620fad99..b81ec9dc 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -489,6 +489,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token" } @@ -512,6 +515,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations-200" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns-200" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token-200" } @@ -3887,7 +3893,7 @@ "additionalProperties" : false, "properties" : { "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -4307,7 +4313,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -4319,7 +4325,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -4335,7 +4341,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6335,6 +6341,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -6359,10 +6369,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -7971,7 +7989,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -7992,7 +8010,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8225,7 +8243,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8502,6 +8520,55 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -11165,7 +11232,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -11177,7 +11244,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -11688,6 +11755,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -11785,7 +11855,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -12179,7 +12249,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -12201,7 +12271,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -15556,6 +15626,46 @@ } } }, + "post-donations-donations-with-campaigns" : { + "summary" : "Start a donation transaction for a donation campaign", + "value" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "paymentMethod" : { + "type" : "scheme" + }, + "donationToken" : "YOUR_DONATION_TOKEN", + "donationOriginalPspReference" : "991559660454807J", + "donationCampaignId" : "DONATION_CAMPAIGN_ID", + "returnUrl" : "https://your-company.com/...", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-donations-donations-with-campaigns-200" : { + "summary" : "Example response", + "value" : { + "id" : "UNIQUE_RESOURCE_ID", + "status" : "completed", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "payment" : { + "pspReference" : "8535762347980628", + "resultCode" : "Authorised", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_DONATION_REFERENCE" + } + } + }, "post-donations-donations-with-token" : { "summary" : "Start a donation transaction with a token", "value" : { diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index 80d0280f..68192c10 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -489,6 +489,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token" } @@ -512,6 +515,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations-200" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns-200" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token-200" } @@ -3890,7 +3896,7 @@ "deprecated" : true, "x-deprecatedInVersion" : "69", "x-deprecatedMessage" : "Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.", - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -4313,7 +4319,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -4325,7 +4331,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -4341,7 +4347,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6370,6 +6376,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -6394,10 +6404,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -8095,7 +8113,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8121,7 +8139,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8354,7 +8372,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8634,6 +8652,55 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -11375,7 +11442,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -11387,7 +11454,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -11903,6 +11970,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -12000,7 +12070,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -12405,7 +12475,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -12427,7 +12497,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -15832,6 +15902,46 @@ } } }, + "post-donations-donations-with-campaigns" : { + "summary" : "Start a donation transaction for a donation campaign", + "value" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "paymentMethod" : { + "type" : "scheme" + }, + "donationToken" : "YOUR_DONATION_TOKEN", + "donationOriginalPspReference" : "991559660454807J", + "donationCampaignId" : "DONATION_CAMPAIGN_ID", + "returnUrl" : "https://your-company.com/...", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-donations-donations-with-campaigns-200" : { + "summary" : "Example response", + "value" : { + "id" : "UNIQUE_RESOURCE_ID", + "status" : "completed", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "payment" : { + "pspReference" : "8535762347980628", + "resultCode" : "Authorised", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_DONATION_REFERENCE" + } + } + }, "post-donations-donations-with-token" : { "summary" : "Start a donation transaction with a token", "value" : { diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index 6ff015c5..5f6c6e5e 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -489,6 +489,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token" } @@ -512,6 +515,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations-200" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns-200" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token-200" } @@ -4002,7 +4008,7 @@ "deprecated" : true, "x-deprecatedInVersion" : "69", "x-deprecatedMessage" : "Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.", - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -4425,7 +4431,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -4437,7 +4443,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -4453,7 +4459,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6482,6 +6488,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -6506,10 +6516,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -8247,7 +8265,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8273,7 +8291,7 @@ "$ref" : "#/components/schemas/BillingAddress" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -8522,7 +8540,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8802,6 +8820,55 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -11642,7 +11709,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -11654,7 +11721,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -12189,6 +12256,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -12286,7 +12356,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -12691,7 +12761,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -12713,7 +12783,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -16170,6 +16240,46 @@ } } }, + "post-donations-donations-with-campaigns" : { + "summary" : "Start a donation transaction for a donation campaign", + "value" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "paymentMethod" : { + "type" : "scheme" + }, + "donationToken" : "YOUR_DONATION_TOKEN", + "donationOriginalPspReference" : "991559660454807J", + "donationCampaignId" : "DONATION_CAMPAIGN_ID", + "returnUrl" : "https://your-company.com/...", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-donations-donations-with-campaigns-200" : { + "summary" : "Example response", + "value" : { + "id" : "UNIQUE_RESOURCE_ID", + "status" : "completed", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "payment" : { + "pspReference" : "8535762347980628", + "resultCode" : "Authorised", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_DONATION_REFERENCE" + } + } + }, "post-donations-donations-with-token" : { "summary" : "Start a donation transaction with a token", "value" : { diff --git a/json/CheckoutService-v71.json b/json/CheckoutService-v71.json index b479c575..dfee4b87 100644 --- a/json/CheckoutService-v71.json +++ b/json/CheckoutService-v71.json @@ -489,6 +489,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token" } @@ -512,6 +515,9 @@ "donations" : { "$ref" : "#/components/examples/post-donations-donations-200" }, + "donations-with-campaigns" : { + "$ref" : "#/components/examples/post-donations-donations-with-campaigns-200" + }, "donations-with-token" : { "$ref" : "#/components/examples/post-donations-donations-with-token-200" } @@ -4002,7 +4008,7 @@ "deprecated" : true, "x-deprecatedInVersion" : "69", "x-deprecatedMessage" : "Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.", - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", + "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.\n", "type" : "string" }, "challengeWindowSize" : { @@ -4425,7 +4431,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -4437,7 +4443,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters\n* Must not start with a space\n* Must not contain any special characters\n* Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -4453,7 +4459,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", + "description" : "The lodging property location's phone number.\n* Format: numeric\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n* Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -6482,6 +6488,10 @@ "CheckoutBankTransferAction" : { "additionalProperties" : false, "properties" : { + "accountNumber" : { + "description" : "The account number of the bank transfer.", + "type" : "string" + }, "beneficiary" : { "description" : "The name of the account holder.", "type" : "string" @@ -6506,10 +6516,18 @@ "description" : "The transfer reference.", "type" : "string" }, + "routingNumber" : { + "description" : "The routing number of the bank transfer.", + "type" : "string" + }, "shopperEmail" : { "description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.", "type" : "string" }, + "sortCode" : { + "description" : "The sort code of the bank transfer.", + "type" : "string" + }, "totalAmount" : { "description" : "The amount of the bank transfer.", "$ref" : "#/components/schemas/Amount" @@ -8383,7 +8401,7 @@ ] }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8626,6 +8644,55 @@ "title" : "Voucher", "type" : "object" }, + "EftDetails" : { + "additionalProperties" : false, + "properties" : { + "bankAccountNumber" : { + "description" : "The bank account number (without separators).", + "type" : "string" + }, + "bankCode" : { + "description" : "The financial institution code.", + "type" : "string" + }, + "bankLocationId" : { + "description" : "The bank routing number of the account.", + "type" : "string" + }, + "checkoutAttemptId" : { + "x-addedInVersion" : "68", + "description" : "The checkout attempt identifier.", + "type" : "string" + }, + "ownerName" : { + "description" : "The name of the bank account holder.\nIf you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:\n* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\nAfter replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:\n* John17 - allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n> If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.", + "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" : "eft_directdebit_CA", + "description" : "**eft**", + "enum" : [ + "eft_directdebit_CA" + ], + "type" : "string" + } + }, + "title" : "EFT Direct Debit", + "type" : "object" + }, "EncryptedOrderData" : { "additionalProperties" : false, "properties" : { @@ -11478,7 +11545,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -11490,7 +11557,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -12025,6 +12092,9 @@ { "$ref" : "#/components/schemas/EcontextVoucherDetails" }, + { + "$ref" : "#/components/schemas/EftDetails" + }, { "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" }, @@ -12122,7 +12192,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : "30", + "x-addedInVersion" : "32", "description" : "Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -12527,7 +12597,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -12549,7 +12619,7 @@ "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : "33", + "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\"]`", "items" : { "type" : "string" @@ -16006,6 +16076,46 @@ } } }, + "post-donations-donations-with-campaigns" : { + "summary" : "Start a donation transaction for a donation campaign", + "value" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "paymentMethod" : { + "type" : "scheme" + }, + "donationToken" : "YOUR_DONATION_TOKEN", + "donationOriginalPspReference" : "991559660454807J", + "donationCampaignId" : "DONATION_CAMPAIGN_ID", + "returnUrl" : "https://your-company.com/...", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" + } + }, + "post-donations-donations-with-campaigns-200" : { + "summary" : "Example response", + "value" : { + "id" : "UNIQUE_RESOURCE_ID", + "status" : "completed", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "reference" : "YOUR_DONATION_REFERENCE", + "payment" : { + "pspReference" : "8535762347980628", + "resultCode" : "Authorised", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_DONATION_REFERENCE" + } + } + }, "post-donations-donations-with-token" : { "summary" : "Start a donation transaction with a token", "value" : { diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index c5c4399c..558dae0d 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -2176,11 +2176,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3154,7 +3154,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3173,8 +3173,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3199,7 +3199,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3211,7 +3211,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5305,7 +5305,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5330,7 +5330,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5541,7 +5541,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -5847,6 +5847,43 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -7838,7 +7875,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7853,7 +7890,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8306,6 +8343,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -8342,7 +8380,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -8720,7 +8758,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8746,7 +8784,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 5c4e0013..6aed045a 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -2352,11 +2352,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3330,7 +3330,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3349,8 +3349,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3375,7 +3375,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3387,7 +3387,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5602,7 +5602,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5632,7 +5632,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5859,7 +5859,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6171,6 +6171,43 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8251,7 +8288,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8266,7 +8303,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8747,6 +8784,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -8783,7 +8821,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9174,7 +9212,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9205,7 +9243,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index dd71b341..a9cd4407 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -2361,11 +2361,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3339,7 +3339,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3358,8 +3358,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3384,7 +3384,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3396,7 +3396,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5611,7 +5611,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5641,7 +5641,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5868,7 +5868,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6180,6 +6180,43 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8264,7 +8301,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8279,7 +8316,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8760,6 +8797,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -8796,7 +8834,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9191,7 +9229,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9222,7 +9260,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 8c960a5f..a5963261 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -2361,11 +2361,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3339,7 +3339,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3358,8 +3358,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3384,7 +3384,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3396,7 +3396,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5611,7 +5611,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5641,7 +5641,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -5868,7 +5868,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6180,6 +6180,43 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8264,7 +8301,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8279,7 +8316,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8760,6 +8797,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -8796,7 +8834,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9191,7 +9229,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9222,7 +9260,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 7f22e713..cc6475e5 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -2370,11 +2370,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3348,7 +3348,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3367,8 +3367,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3393,7 +3393,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3405,7 +3405,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5333,6 +5333,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5351,10 +5354,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -5998,7 +6007,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6028,7 +6037,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6260,7 +6269,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6577,6 +6586,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8781,7 +8836,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8796,7 +8851,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9288,6 +9343,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9324,7 +9380,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9748,7 +9804,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9779,7 +9835,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index b820b0f7..08eaab75 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5360,6 +5360,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5378,10 +5381,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6025,7 +6034,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6055,7 +6064,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6287,7 +6296,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6610,6 +6619,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8824,7 +8879,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8839,7 +8894,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9331,6 +9386,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9367,7 +9423,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9797,7 +9853,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9828,7 +9884,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 7b571f74..d6af045e 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5366,6 +5366,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5384,10 +5387,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6031,7 +6040,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6061,7 +6070,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6299,7 +6308,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6622,6 +6631,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8842,7 +8897,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8857,7 +8912,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9361,6 +9416,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9397,7 +9453,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9827,7 +9883,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9858,7 +9914,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 8f583cb5..e7fa7637 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5366,6 +5366,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5384,10 +5387,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6031,7 +6040,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6061,7 +6070,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6307,7 +6316,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6630,6 +6639,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8854,7 +8909,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8869,7 +8924,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9373,6 +9428,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9409,7 +9465,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9843,7 +9899,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9874,7 +9930,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index 24eb7d58..48c1ab5a 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5366,6 +5366,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5384,10 +5387,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6031,7 +6040,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6061,7 +6070,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6307,7 +6316,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6630,6 +6639,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8861,7 +8916,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8876,7 +8931,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9386,6 +9441,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9422,7 +9478,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9856,7 +9912,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9887,7 +9943,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index e048a70c..2cdc2141 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5366,6 +5366,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5384,10 +5387,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6031,7 +6040,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6061,7 +6070,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6307,7 +6316,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6630,6 +6639,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8920,7 +8975,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8935,7 +8990,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9449,6 +9504,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9485,7 +9541,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9933,7 +9989,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9964,7 +10020,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 6392eecf..bf3c008c 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5377,6 +5377,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5395,10 +5398,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6042,7 +6051,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6072,7 +6081,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6312,7 +6321,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6635,6 +6644,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8918,7 +8973,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8933,7 +8988,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9425,6 +9480,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9461,7 +9517,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9909,7 +9965,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9940,7 +9996,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index b1d198c6..7d2382c3 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -2391,11 +2391,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3369,7 +3369,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3388,8 +3388,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3414,7 +3414,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3426,7 +3426,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5377,6 +5377,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5395,10 +5398,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6042,7 +6051,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6072,7 +6081,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6312,7 +6321,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6635,6 +6644,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -8922,7 +8977,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -8937,7 +8992,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9429,6 +9484,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9465,7 +9521,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -9917,7 +9973,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9948,7 +10004,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index 24eeaf6a..78de5deb 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -393,6 +393,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token' schema: @@ -406,6 +408,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations-200' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns-200' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-200' schema: @@ -2472,11 +2476,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3450,7 +3454,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3469,8 +3473,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3495,7 +3499,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3507,7 +3511,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5473,6 +5477,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5491,10 +5498,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -6206,7 +6219,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6236,7 +6249,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -6481,7 +6494,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -6804,6 +6817,52 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -9114,7 +9173,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9129,7 +9188,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -9621,6 +9680,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -9657,7 +9717,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -10077,7 +10137,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -10108,7 +10168,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -13161,6 +13221,37 @@ components: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE + post-donations-donations-with-campaigns: + summary: Start a donation transaction for a donation campaign + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationCampaignId: DONATION_CAMPAIGN_ID + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-donations-donations-with-campaigns-200: + summary: Example response + value: + id: UNIQUE_RESOURCE_ID + status: completed + merchantAccount: YOUR_MERCHANT_ACCOUNT + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + payment: + pspReference: '8535762347980628' + resultCode: Authorised + amount: + currency: EUR + value: 1000 + merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-with-token: summary: Start a donation transaction with a token value: diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index 0f5c470b..4bbf3e4c 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -393,6 +393,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token' schema: @@ -406,6 +408,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations-200' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns-200' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-200' schema: @@ -2731,11 +2735,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3709,7 +3713,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3728,8 +3732,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3754,7 +3758,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3766,7 +3770,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5796,6 +5800,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5814,10 +5821,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -7380,7 +7393,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7410,7 +7423,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7679,7 +7692,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -8014,6 +8027,56 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -10505,7 +10568,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -10520,7 +10583,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11033,6 +11096,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -11073,7 +11137,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -11493,7 +11557,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11524,7 +11588,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -15075,6 +15139,37 @@ components: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE + post-donations-donations-with-campaigns: + summary: Start a donation transaction for a donation campaign + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationCampaignId: DONATION_CAMPAIGN_ID + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-donations-donations-with-campaigns-200: + summary: Example response + value: + id: UNIQUE_RESOURCE_ID + status: completed + merchantAccount: YOUR_MERCHANT_ACCOUNT + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + payment: + pspReference: '8535762347980628' + resultCode: Authorised + amount: + currency: EUR + value: 1000 + merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-with-token: summary: Start a donation transaction with a token value: diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 9926a797..8a6d76b7 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -393,6 +393,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token' schema: @@ -406,6 +408,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations-200' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns-200' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-200' schema: @@ -2735,11 +2739,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3717,7 +3721,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3736,8 +3740,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3762,7 +3766,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3774,7 +3778,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5841,6 +5845,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5859,10 +5866,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -7504,7 +7517,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7538,7 +7551,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7807,7 +7820,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -8145,6 +8158,56 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -10724,7 +10787,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -10739,7 +10802,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11256,6 +11319,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -11296,7 +11360,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -11725,7 +11789,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11756,7 +11820,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -15367,6 +15431,37 @@ components: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE + post-donations-donations-with-campaigns: + summary: Start a donation transaction for a donation campaign + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationCampaignId: DONATION_CAMPAIGN_ID + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-donations-donations-with-campaigns-200: + summary: Example response + value: + id: UNIQUE_RESOURCE_ID + status: completed + merchantAccount: YOUR_MERCHANT_ACCOUNT + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + payment: + pspReference: '8535762347980628' + resultCode: Authorised + amount: + currency: EUR + value: 1000 + merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-with-token: summary: Start a donation transaction with a token value: diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index 42cd81c2..bf36bf91 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -393,6 +393,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token' schema: @@ -406,6 +408,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations-200' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns-200' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-200' schema: @@ -2818,11 +2822,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3800,7 +3804,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3819,8 +3823,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3845,7 +3849,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3857,7 +3861,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5924,6 +5928,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5942,10 +5949,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -7635,7 +7648,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7669,7 +7682,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/BillingAddress' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -7958,7 +7971,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -8296,6 +8309,56 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -10961,7 +11024,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -10976,7 +11039,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11516,6 +11579,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -11556,7 +11620,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -11985,7 +12049,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -12016,7 +12080,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -15687,6 +15751,37 @@ components: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE + post-donations-donations-with-campaigns: + summary: Start a donation transaction for a donation campaign + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationCampaignId: DONATION_CAMPAIGN_ID + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-donations-donations-with-campaigns-200: + summary: Example response + value: + id: UNIQUE_RESOURCE_ID + status: completed + merchantAccount: YOUR_MERCHANT_ACCOUNT + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + payment: + pspReference: '8535762347980628' + resultCode: Authorised + amount: + currency: EUR + value: 1000 + merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-with-token: summary: Start a donation transaction with a token value: diff --git a/yaml/CheckoutService-v71.yaml b/yaml/CheckoutService-v71.yaml index f577c894..6df38e49 100644 --- a/yaml/CheckoutService-v71.yaml +++ b/yaml/CheckoutService-v71.yaml @@ -393,6 +393,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token' schema: @@ -406,6 +408,8 @@ paths: examples: donations: $ref: '#/components/examples/post-donations-donations-200' + donations-with-campaigns: + $ref: '#/components/examples/post-donations-donations-with-campaigns-200' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-200' schema: @@ -2818,11 +2822,11 @@ components: \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" + \ not mean always applying 3D Secure 2. Adyen selects redirect or native\ + \ authentication based on your configuration to optimize authorization\ + \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ + \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ + \ 3D Secure 2 authentication instead, based on your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to\ @@ -3800,7 +3804,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3819,8 +3823,8 @@ components: type: string lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - *Must not be all zeros." + \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ + * Must not contain any special characters\n* Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3845,7 +3849,7 @@ components: lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. - * Format: numeric. + * Format: numeric * Min length: 10 characters @@ -3857,7 +3861,7 @@ components: * Must not contain any special characters such as + or - - *Must not be all zeros.' + * Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -5924,6 +5928,9 @@ components: CheckoutBankTransferAction: additionalProperties: false properties: + accountNumber: + description: The account number of the bank transfer. + type: string beneficiary: description: The name of the account holder. type: string @@ -5942,10 +5949,16 @@ components: reference: description: The transfer reference. type: string + routingNumber: + description: The routing number of the bank transfer. + type: string shopperEmail: description: The e-mail of the shopper, included if an e-mail was sent to the shopper. type: string + sortCode: + description: The sort code of the bank transfer. + type: string totalAmount: description: The amount of the bank transfer. $ref: '#/components/schemas/Amount' @@ -7799,7 +7812,7 @@ components: - $ref: '#/components/schemas/IdealDonations' - $ref: '#/components/schemas/PayWithGoogleDonations' recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -8094,6 +8107,56 @@ components: - telephoneNumber title: Voucher type: object + EftDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCode: + description: The financial institution code. + type: string + bankLocationId: + description: The bank routing number of the account. + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: The checkout attempt identifier. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + 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: eft_directdebit_CA + description: '**eft**' + enum: + - eft_directdebit_CA + type: string + title: EFT Direct Debit + type: object EncryptedOrderData: additionalProperties: false properties: @@ -10773,7 +10836,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -10788,7 +10851,7 @@ components: requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11328,6 +11391,7 @@ components: - $ref: '#/components/schemas/DotpayDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GiropayDetails' - $ref: '#/components/schemas/GooglePayDetails' @@ -11368,7 +11432,7 @@ components: Secure 2. type: string recurringProcessingModel: - x-addedInVersion: '30' + x-addedInVersion: '32' description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ @@ -11797,7 +11861,7 @@ components: the key and value.' type: object allowedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -11828,7 +11892,7 @@ components: >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: - x-addedInVersion: '33' + 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). @@ -15499,6 +15563,37 @@ components: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE + post-donations-donations-with-campaigns: + summary: Start a donation transaction for a donation campaign + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationCampaignId: DONATION_CAMPAIGN_ID + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-donations-donations-with-campaigns-200: + summary: Example response + value: + id: UNIQUE_RESOURCE_ID + status: completed + merchantAccount: YOUR_MERCHANT_ACCOUNT + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + payment: + pspReference: '8535762347980628' + resultCode: Authorised + amount: + currency: EUR + value: 1000 + merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-with-token: summary: Start a donation transaction with a token value: