Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Sep 10, 2024
1 parent 6559c7d commit 08baea2
Show file tree
Hide file tree
Showing 34 changed files with 2,746 additions and 506 deletions.
62 changes: 50 additions & 12 deletions json/CheckoutService-v37.json
Original file line number Diff line number Diff line change
Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand All @@ -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" : {
Expand All @@ -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" : {
Expand Down Expand Up @@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -8964,6 +8999,9 @@
{
"$ref" : "#/components/schemas/EcontextVoucherDetails"
},
{
"$ref" : "#/components/schemas/EftDetails"
},
{
"$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails"
},
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
Expand All @@ -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"
Expand Down
Loading

0 comments on commit 08baea2

Please sign in to comment.