From a9f04c60d7017c22c29f8f87c67b657315ae6745 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Fri, 24 Feb 2023 13:28:16 +0000 Subject: [PATCH] spec release --- json/BalanceControlService-v1.json | 13 +- json/CheckoutService-v37.json | 476 +++++++++++++------- json/CheckoutService-v40.json | 533 +++++++++++++++-------- json/CheckoutService-v41.json | 540 +++++++++++++++-------- json/CheckoutService-v46.json | 536 +++++++++++++++-------- json/CheckoutService-v49.json | 610 +++++++++++++++++--------- json/CheckoutService-v50.json | 604 ++++++++++++++++++-------- json/CheckoutService-v51.json | 596 +++++++++++++++++-------- json/CheckoutService-v52.json | 596 +++++++++++++++++-------- json/CheckoutService-v53.json | 596 +++++++++++++++++-------- json/CheckoutService-v64.json | 596 +++++++++++++++++-------- json/CheckoutService-v65.json | 593 +++++++++++++++++-------- json/CheckoutService-v66.json | 593 +++++++++++++++++-------- json/CheckoutService-v67.json | 619 +++++++++++++++++--------- json/CheckoutService-v68.json | 673 +++++++++++++++++++---------- json/CheckoutService-v69.json | 650 +++++++++++++++++++--------- json/CheckoutService-v70.json | 654 +++++++++++++++++++--------- json/PaymentService-v25.json | 175 +++++--- json/PaymentService-v30.json | 185 +++++--- json/PaymentService-v40.json | 244 +++++++---- json/PaymentService-v46.json | 244 +++++++---- json/PaymentService-v49.json | 244 +++++++---- json/PaymentService-v50.json | 244 +++++++---- json/PaymentService-v51.json | 255 +++++++---- json/PaymentService-v52.json | 255 +++++++---- json/PaymentService-v64.json | 264 +++++++---- json/PaymentService-v67.json | 264 +++++++---- json/PaymentService-v68.json | 363 +++++++++++----- json/StoredValueService-v46.json | 56 ++- yaml/BalanceControlService-v1.yaml | 7 +- yaml/CheckoutService-v37.yaml | 188 +++++++- yaml/CheckoutService-v40.yaml | 229 ++++++++-- yaml/CheckoutService-v41.yaml | 234 ++++++++-- yaml/CheckoutService-v46.yaml | 230 ++++++++-- yaml/CheckoutService-v49.yaml | 277 ++++++++++-- yaml/CheckoutService-v50.yaml | 275 ++++++++++-- yaml/CheckoutService-v51.yaml | 269 ++++++++++-- yaml/CheckoutService-v52.yaml | 269 ++++++++++-- yaml/CheckoutService-v53.yaml | 269 ++++++++++-- yaml/CheckoutService-v64.yaml | 269 ++++++++++-- yaml/CheckoutService-v65.yaml | 268 ++++++++++-- yaml/CheckoutService-v66.yaml | 268 ++++++++++-- yaml/CheckoutService-v67.yaml | 296 +++++++++++-- yaml/CheckoutService-v68.yaml | 324 ++++++++++++-- yaml/CheckoutService-v69.yaml | 291 +++++++++++-- yaml/CheckoutService-v70.yaml | 291 +++++++++++-- yaml/PaymentService-v25.yaml | 84 +++- yaml/PaymentService-v30.yaml | 90 +++- yaml/PaymentService-v40.yaml | 115 ++++- yaml/PaymentService-v46.yaml | 115 ++++- yaml/PaymentService-v49.yaml | 115 ++++- yaml/PaymentService-v50.yaml | 115 ++++- yaml/PaymentService-v51.yaml | 120 ++++- yaml/PaymentService-v52.yaml | 120 ++++- yaml/PaymentService-v64.yaml | 123 +++++- yaml/PaymentService-v67.yaml | 123 +++++- yaml/PaymentService-v68.yaml | 239 +++++++++- yaml/StoredValueService-v46.yaml | 28 +- 58 files changed, 13096 insertions(+), 4816 deletions(-) diff --git a/json/BalanceControlService-v1.json b/json/BalanceControlService-v1.json index c8a02aa..82aceb5 100644 --- a/json/BalanceControlService-v1.json +++ b/json/BalanceControlService-v1.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Balance Control API", "description" : "The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account.\n\n## Authentication\nTo connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key:\n\n```\ncurl\n-H \"X-API-Key: Your_API_key\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Balance Control API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n\n```\nhttps://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer\n```\n", - "x-timestamp" : "2022-11-24T10:17:10Z", + "x-timestamp" : "2023-02-20T18:23:08Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -37,7 +37,7 @@ "operationId" : "post-balanceTransfer", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "startBalanceTransfer", + "x-methodName" : "balanceTransfer", "security" : [ { "BasicAuth" : [ @@ -101,7 +101,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "BalanceTransferRequest" : { "properties" : { @@ -145,7 +146,8 @@ "fromMerchant", "toMerchant", "type" - ] + ], + "type" : "object" }, "BalanceTransferResponse" : { "properties" : { @@ -211,7 +213,8 @@ "pspReference", "status", "createdAt" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index 1fe5535..eaca53d 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v37/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v37/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=37) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:12Z", + "x-timestamp" : "2023-02-20T18:22:12Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2111,6 +2113,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3075,7 +3079,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3110,7 +3115,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3229,7 +3235,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3325,7 +3332,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3333,6 +3341,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3359,6 +3371,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3399,7 +3415,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3471,7 +3488,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3543,7 +3561,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3619,7 +3638,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3627,7 +3647,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3663,7 +3684,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3679,7 +3701,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3767,7 +3790,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -3831,7 +3855,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -3875,7 +3900,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -3915,7 +3941,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -3943,7 +3970,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -3981,7 +4009,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4016,7 +4045,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4034,7 +4064,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4053,7 +4084,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4067,7 +4099,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4100,7 +4133,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4111,7 +4145,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4139,7 +4174,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4156,7 +4192,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4174,7 +4211,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4216,7 +4254,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4240,7 +4279,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4261,7 +4301,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4277,7 +4318,8 @@ "required" : [ "userAgent", "acceptHeader" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4333,7 +4375,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4345,7 +4388,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4435,12 +4479,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4471,7 +4511,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4482,7 +4523,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4500,7 +4542,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -4756,10 +4799,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -4825,7 +4867,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -4841,7 +4884,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -4860,7 +4904,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -4885,7 +4930,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -4963,7 +5009,8 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -4979,7 +5026,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5010,7 +5058,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5024,7 +5073,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5036,7 +5086,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CommonField" : { "properties" : { @@ -5048,7 +5099,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5076,7 +5128,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5103,7 +5156,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5124,7 +5178,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5159,7 +5214,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5174,7 +5230,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5208,7 +5265,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5224,6 +5282,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5318,7 +5377,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5350,7 +5409,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5395,7 +5455,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -5410,7 +5471,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -5430,7 +5492,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -5446,7 +5509,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -5485,7 +5549,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -5522,7 +5587,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -5543,7 +5609,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -5571,7 +5638,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -5608,7 +5676,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -5624,7 +5693,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -5682,7 +5752,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -5705,7 +5776,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -5724,7 +5796,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -5752,7 +5825,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -5770,7 +5844,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -5802,7 +5877,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -5827,7 +5903,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -5880,7 +5957,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -5889,7 +5967,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -5901,7 +5980,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -5913,7 +5993,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -5925,7 +6006,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -5964,7 +6046,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6013,7 +6096,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6073,7 +6157,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6101,7 +6186,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6127,7 +6213,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6143,7 +6230,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6157,7 +6245,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6179,7 +6268,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6195,7 +6285,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6227,7 +6318,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -6264,7 +6356,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -6293,7 +6386,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -6325,7 +6419,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -6379,7 +6474,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -6412,7 +6508,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -6464,7 +6561,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -6543,7 +6641,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -6647,7 +6746,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -6759,7 +6859,8 @@ "description" : "The shopperLocale.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -7213,7 +7314,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -7229,6 +7331,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -7323,7 +7426,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -7400,7 +7503,8 @@ "merchantAccount", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -7442,7 +7546,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -7458,7 +7563,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -7477,7 +7583,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -7591,7 +7698,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -7616,7 +7724,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -7679,7 +7788,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -8120,7 +8230,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -8219,7 +8330,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -8252,7 +8364,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -8566,7 +8679,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -8582,7 +8696,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -8594,7 +8709,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -8697,7 +8813,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -8731,7 +8848,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -8757,7 +8875,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -8807,7 +8926,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -8830,7 +8950,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -8854,7 +8975,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -8882,7 +9004,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -8918,7 +9041,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -9160,7 +9284,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -9212,7 +9337,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -9228,7 +9354,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -9236,7 +9363,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -9252,7 +9380,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -9260,7 +9389,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -9292,7 +9422,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -9323,7 +9454,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -9348,7 +9480,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -9364,7 +9497,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -9395,7 +9529,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -9411,7 +9546,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -9451,7 +9587,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -9469,7 +9606,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -9502,7 +9640,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -9518,7 +9657,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -9550,7 +9690,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -9584,7 +9725,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -9630,7 +9772,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -9666,7 +9809,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -9700,7 +9844,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -9725,7 +9870,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -9750,7 +9896,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -9778,7 +9925,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -9793,7 +9941,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -9813,7 +9962,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -9836,7 +9986,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -9991,7 +10142,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -10077,7 +10228,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -14498,7 +14649,8 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -14661,7 +14813,7 @@ "paymentMethod" : { "type" : "scheme", "recurringDetailReference" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 8daa8e9..8972534 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v40/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v40/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=40) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:14Z", + "x-timestamp" : "2023-02-20T18:22:14Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2150,6 +2152,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3191,7 +3195,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3232,7 +3237,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3267,7 +3273,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3386,7 +3393,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3482,7 +3490,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3490,6 +3499,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3516,6 +3529,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3556,7 +3573,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3628,7 +3646,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3700,7 +3719,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3776,7 +3796,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3784,7 +3805,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3820,7 +3842,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3836,7 +3859,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3924,7 +3948,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -3988,7 +4013,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4032,7 +4058,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4072,7 +4099,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4100,7 +4128,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4138,7 +4167,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4173,7 +4203,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4191,7 +4222,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4210,7 +4242,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4224,7 +4257,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4257,7 +4291,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4268,7 +4303,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4296,7 +4332,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4313,7 +4350,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4331,7 +4369,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4373,7 +4412,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4397,7 +4437,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4418,7 +4459,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4480,7 +4522,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4536,7 +4579,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4548,7 +4592,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4638,12 +4683,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4674,7 +4715,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4685,7 +4727,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4703,7 +4746,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -4979,10 +5023,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5048,7 +5091,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5064,7 +5108,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5083,7 +5128,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5108,7 +5154,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5186,7 +5233,8 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5202,7 +5250,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5233,7 +5282,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5247,7 +5297,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5259,7 +5310,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CommonField" : { "properties" : { @@ -5271,7 +5323,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5299,7 +5352,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5326,7 +5380,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5347,7 +5402,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5382,7 +5438,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5397,7 +5454,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5431,7 +5489,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5447,6 +5506,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5541,7 +5601,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5573,7 +5633,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5618,7 +5679,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -5633,7 +5695,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -5653,7 +5716,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -5674,7 +5738,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -5702,7 +5767,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -5741,7 +5807,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -5778,7 +5845,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -5799,7 +5867,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -5827,7 +5896,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -5864,7 +5934,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -5880,7 +5951,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -5938,7 +6010,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -5961,7 +6034,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -5980,7 +6054,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6008,7 +6083,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6026,7 +6102,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6058,7 +6135,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6083,7 +6161,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6136,7 +6215,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6145,7 +6225,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6157,7 +6238,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6169,7 +6251,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6181,7 +6264,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6220,7 +6304,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6269,7 +6354,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6329,7 +6415,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6357,7 +6444,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6383,7 +6471,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6399,7 +6488,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6456,7 +6546,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6470,7 +6561,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6492,7 +6584,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6508,7 +6601,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6540,7 +6634,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -6577,7 +6672,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -6606,7 +6702,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -6638,7 +6735,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -6692,7 +6790,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -6725,7 +6824,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -6777,7 +6877,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -6856,7 +6957,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -6960,7 +7062,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7076,7 +7179,8 @@ "description" : "The shopperLocale.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -7556,7 +7660,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -7572,6 +7677,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -7666,7 +7772,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -7743,7 +7849,8 @@ "merchantAccount", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -7785,7 +7892,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -7801,7 +7909,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -7820,7 +7929,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -7934,7 +8044,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -7959,7 +8070,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8022,7 +8134,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -8489,7 +8602,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -8596,7 +8710,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -8629,7 +8744,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -8948,7 +9064,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -8964,7 +9081,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -8976,7 +9094,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9074,7 +9193,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9108,7 +9228,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9145,7 +9266,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9195,7 +9317,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9218,7 +9341,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9242,7 +9366,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9270,7 +9395,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9306,7 +9432,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -9568,7 +9695,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -9620,7 +9748,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -9636,7 +9765,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -9644,7 +9774,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -9660,7 +9791,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -9668,7 +9800,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -9688,7 +9821,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -9720,7 +9854,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -9751,7 +9886,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -9776,7 +9912,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -9792,7 +9929,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -9823,7 +9961,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -9839,7 +9978,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -9879,7 +10019,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -9897,7 +10038,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -9930,7 +10072,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -9946,7 +10089,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -9978,7 +10122,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10012,7 +10157,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10098,7 +10244,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10154,7 +10301,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10190,7 +10338,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -10224,7 +10373,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -10249,7 +10399,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -10274,7 +10425,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -10302,7 +10454,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -10317,7 +10470,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -10337,7 +10491,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -10360,7 +10515,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -10515,7 +10671,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -10601,7 +10757,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15049,7 +15205,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15090,7 +15252,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15218,8 +15386,7 @@ "encryptedCardNumber" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryMonth" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryYear" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "storeDetails" : true + "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -15240,8 +15407,7 @@ "expiryMonth" : "03", "expiryYear" : "2030", "holderName" : "John Smith", - "cvc" : "737", - "storeDetails" : true + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -15343,7 +15509,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -15372,24 +15538,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -15407,7 +15573,7 @@ "paymentMethod" : { "type" : "scheme", "recurringDetailReference" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -15441,6 +15607,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "recurringDetailReference" : "8315791039321763" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index e6d1069..33251d6 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v41/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v41/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=41) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:14Z", + "x-timestamp" : "2023-02-20T18:22:15Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2165,6 +2167,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3206,7 +3210,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3247,7 +3252,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3282,7 +3288,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3401,7 +3408,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3497,7 +3505,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3505,6 +3514,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3531,6 +3544,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3571,7 +3588,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3643,7 +3661,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3715,7 +3734,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3791,7 +3811,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3799,7 +3820,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3835,7 +3857,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3851,7 +3874,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3939,7 +3963,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4003,7 +4028,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4047,7 +4073,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4087,7 +4114,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4115,7 +4143,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4153,7 +4182,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4188,7 +4218,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4206,7 +4237,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4225,7 +4257,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4239,7 +4272,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4272,7 +4306,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4283,7 +4318,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4311,7 +4347,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4328,7 +4365,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4346,7 +4384,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4388,7 +4427,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4412,7 +4452,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4433,7 +4474,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4495,7 +4537,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4551,7 +4594,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4563,7 +4607,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4653,12 +4698,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4689,7 +4730,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4700,7 +4742,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4718,7 +4761,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -4994,10 +5038,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5063,7 +5106,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5079,7 +5123,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5098,7 +5143,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5123,7 +5169,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5201,7 +5248,8 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5217,7 +5265,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5248,7 +5297,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5262,7 +5312,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5274,7 +5325,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CommonField" : { "properties" : { @@ -5286,7 +5338,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5314,7 +5367,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5341,7 +5395,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5362,7 +5417,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5397,7 +5453,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5412,7 +5469,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5446,7 +5504,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5462,6 +5521,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5556,7 +5616,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5588,7 +5648,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5633,7 +5694,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -5648,7 +5710,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -5668,7 +5731,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -5689,7 +5753,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -5717,7 +5782,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -5756,7 +5822,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -5793,7 +5860,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -5814,7 +5882,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -5842,7 +5911,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -5879,7 +5949,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -5895,7 +5966,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -5953,7 +6025,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -5976,7 +6049,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -5995,7 +6069,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6023,7 +6098,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6041,7 +6117,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6073,7 +6150,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6098,7 +6176,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6151,7 +6230,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6160,7 +6240,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6172,7 +6253,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6184,7 +6266,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6196,7 +6279,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6235,7 +6319,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6284,7 +6369,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6344,7 +6430,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6372,7 +6459,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6398,7 +6486,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6414,7 +6503,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6471,7 +6561,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6485,7 +6576,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6507,7 +6599,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6523,7 +6616,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6555,7 +6649,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -6592,7 +6687,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -6621,7 +6717,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -6653,7 +6750,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -6707,7 +6805,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -6740,7 +6839,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -6792,7 +6892,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -6871,7 +6972,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -6975,7 +7077,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7096,7 +7199,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -7576,7 +7680,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -7592,6 +7697,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -7686,7 +7792,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -7763,7 +7869,8 @@ "merchantAccount", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -7805,7 +7912,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -7821,7 +7929,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -7840,7 +7949,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -7954,7 +8064,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -7979,7 +8090,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8042,7 +8154,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -8509,7 +8622,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -8621,7 +8735,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -8654,7 +8769,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -8973,7 +9089,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -8989,7 +9106,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9001,7 +9119,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9099,7 +9218,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9133,7 +9253,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9170,7 +9291,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9220,7 +9342,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9243,7 +9366,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9267,7 +9391,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9295,7 +9420,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9331,7 +9457,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -9593,7 +9720,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -9645,7 +9773,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -9661,7 +9790,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -9669,7 +9799,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -9685,7 +9816,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -9693,7 +9825,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -9713,7 +9846,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -9745,7 +9879,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -9776,7 +9911,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -9801,7 +9937,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -9817,7 +9954,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -9848,7 +9986,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -9864,7 +10003,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -9904,7 +10044,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -9922,7 +10063,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -9955,7 +10097,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -9971,7 +10114,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10003,7 +10147,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10037,7 +10182,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10123,7 +10269,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10155,7 +10302,8 @@ "description" : "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10211,7 +10359,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10247,7 +10396,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -10281,7 +10431,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -10306,7 +10457,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -10331,7 +10483,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -10359,7 +10512,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -10374,7 +10528,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -10394,7 +10549,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -10417,7 +10573,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -10572,7 +10729,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -10658,7 +10815,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15105,7 +15262,7 @@ "cvc" : "737" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "accountInfo" : { "accountCreationDate" : "2019-01-17T13:42:40+01:00" @@ -15129,7 +15286,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15170,7 +15327,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15211,7 +15374,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15357,8 +15526,7 @@ "encryptedCardNumber" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryMonth" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryYear" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "storeDetails" : true + "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -15379,8 +15547,7 @@ "expiryMonth" : "03", "expiryYear" : "2030", "holderName" : "John Smith", - "cvc" : "737", - "storeDetails" : true + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -15498,7 +15665,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -15527,24 +15694,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -15562,7 +15729,7 @@ "paymentMethod" : { "type" : "scheme", "recurringDetailReference" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -15596,6 +15763,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "recurringDetailReference" : "8315791039321763" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index edefbd1..d6a97c8 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v46/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v46/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=46) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:15Z", + "x-timestamp" : "2023-02-20T18:22:16Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2165,6 +2167,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3206,7 +3210,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3247,7 +3252,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3282,7 +3288,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3401,7 +3408,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3497,7 +3505,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3505,6 +3514,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3531,6 +3544,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3571,7 +3588,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3643,7 +3661,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3715,7 +3734,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3791,7 +3811,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3799,7 +3820,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3835,7 +3857,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3851,7 +3874,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3939,7 +3963,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4003,7 +4028,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4047,7 +4073,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4087,7 +4114,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4115,7 +4143,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4153,7 +4182,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4188,7 +4218,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4206,7 +4237,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4225,7 +4257,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4239,7 +4272,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4272,7 +4306,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4283,7 +4318,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4311,7 +4347,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4328,7 +4365,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4346,7 +4384,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4388,7 +4427,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4412,7 +4452,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4433,7 +4474,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4495,7 +4537,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4551,7 +4594,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4563,7 +4607,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4653,12 +4698,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4689,7 +4730,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4700,7 +4742,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4718,7 +4761,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -4994,10 +5038,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5063,7 +5106,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5079,7 +5123,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5098,7 +5143,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5123,7 +5169,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5201,7 +5248,8 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5217,7 +5265,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5248,7 +5297,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5262,7 +5312,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5274,7 +5325,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CommonField" : { "properties" : { @@ -5286,7 +5338,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5314,7 +5367,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5341,7 +5395,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5362,7 +5417,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5397,7 +5453,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5412,7 +5469,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5446,7 +5504,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5462,6 +5521,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5556,7 +5616,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5588,7 +5648,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5633,7 +5694,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -5648,7 +5710,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -5668,7 +5731,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -5689,7 +5753,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -5717,7 +5782,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -5756,7 +5822,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -5793,7 +5860,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -5814,7 +5882,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -5842,7 +5911,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -5879,7 +5949,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -5895,7 +5966,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -5953,7 +6025,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -5976,7 +6049,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -5995,7 +6069,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6023,7 +6098,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6041,7 +6117,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6073,7 +6150,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6098,7 +6176,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6151,7 +6230,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6160,7 +6240,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6172,7 +6253,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6184,7 +6266,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6196,7 +6279,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6235,7 +6319,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6284,7 +6369,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6344,7 +6430,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6372,7 +6459,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6398,7 +6486,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6414,7 +6503,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6471,7 +6561,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6485,7 +6576,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6507,7 +6599,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6523,7 +6616,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6555,7 +6649,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -6592,7 +6687,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -6621,7 +6717,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -6653,7 +6750,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -6707,7 +6805,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -6740,7 +6839,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -6792,7 +6892,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -6871,7 +6972,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -6975,7 +7077,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7096,7 +7199,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -7576,7 +7680,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -7592,6 +7697,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -7686,7 +7792,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -7763,7 +7869,8 @@ "merchantAccount", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -7805,7 +7912,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -7821,7 +7929,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -7840,7 +7949,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -7954,7 +8064,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -7979,7 +8090,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8042,7 +8154,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -8509,7 +8622,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -8621,7 +8735,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -8654,7 +8769,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -8973,7 +9089,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -8989,7 +9106,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9001,7 +9119,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9099,7 +9218,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9133,7 +9253,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9170,7 +9291,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9220,7 +9342,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9243,7 +9366,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9267,7 +9391,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9295,7 +9420,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9331,7 +9457,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -9593,7 +9720,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -9645,7 +9773,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -9661,7 +9790,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -9669,7 +9799,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -9685,7 +9816,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -9693,7 +9825,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -9713,7 +9846,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -9745,7 +9879,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -9776,7 +9911,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -9809,7 +9945,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -9825,7 +9962,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -9856,7 +9994,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -9872,7 +10011,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -9912,7 +10052,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -9930,7 +10071,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -9963,7 +10105,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -9979,7 +10122,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10011,7 +10155,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10045,7 +10190,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10131,7 +10277,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10163,7 +10310,8 @@ "description" : "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10219,7 +10367,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10255,7 +10404,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -10289,7 +10439,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -10314,7 +10465,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -10339,7 +10491,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -10367,7 +10520,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -10382,7 +10536,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -10402,7 +10557,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -10425,7 +10581,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -10580,7 +10737,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -10666,7 +10823,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15179,7 +15336,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15220,7 +15383,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15366,8 +15535,7 @@ "encryptedCardNumber" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryMonth" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryYear" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "storeDetails" : true + "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -15388,8 +15556,7 @@ "expiryMonth" : "03", "expiryYear" : "2030", "holderName" : "John Smith", - "cvc" : "737", - "storeDetails" : true + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -15507,7 +15674,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -15536,24 +15703,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -15571,7 +15738,7 @@ "paymentMethod" : { "type" : "scheme", "recurringDetailReference" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -15605,6 +15772,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "recurringDetailReference" : "8315791039321763" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 22064dc..92d62bb 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v49/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v49/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=49) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:15Z", + "x-timestamp" : "2023-02-20T18:22:16Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2165,6 +2167,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3206,7 +3210,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3255,7 +3260,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3290,7 +3296,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3409,7 +3416,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3505,7 +3513,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3513,6 +3522,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3539,6 +3552,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3579,7 +3596,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3651,7 +3669,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3723,7 +3742,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3799,7 +3819,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3807,7 +3828,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3843,7 +3865,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3859,7 +3882,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3947,7 +3971,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4011,7 +4036,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4055,7 +4081,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4095,7 +4122,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4123,7 +4151,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4161,7 +4190,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4204,7 +4234,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4222,7 +4253,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4241,7 +4273,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4255,7 +4288,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4296,7 +4330,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4307,7 +4342,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4335,7 +4371,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4352,7 +4389,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4378,7 +4416,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4420,7 +4459,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4444,7 +4484,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4473,7 +4514,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4535,7 +4577,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4591,7 +4634,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4603,7 +4647,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4701,12 +4746,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4737,7 +4778,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4748,7 +4790,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4766,7 +4809,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4793,7 +4837,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5069,10 +5114,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5138,7 +5182,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5154,7 +5199,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5173,7 +5219,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5198,7 +5245,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5276,7 +5324,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5292,7 +5384,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5323,7 +5416,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5354,7 +5448,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5392,7 +5487,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5427,7 +5523,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5458,7 +5555,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5489,7 +5587,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5503,7 +5602,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5515,7 +5615,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5606,7 +5707,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5618,7 +5720,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5646,7 +5749,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5673,7 +5777,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5694,7 +5799,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5729,7 +5835,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5744,7 +5851,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5778,7 +5886,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5794,6 +5903,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5888,7 +5998,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5920,7 +6030,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5965,7 +6076,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -5980,7 +6092,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6000,7 +6113,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6021,7 +6135,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6049,7 +6164,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6088,7 +6204,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6125,7 +6242,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6146,7 +6264,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6174,7 +6293,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6211,7 +6331,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6227,7 +6348,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6285,7 +6407,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6308,7 +6431,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6327,7 +6451,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6363,7 +6488,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6389,7 +6515,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6429,7 +6556,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6462,7 +6590,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6515,7 +6644,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6524,7 +6654,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6536,7 +6667,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6548,7 +6680,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6560,7 +6693,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6607,7 +6741,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6656,7 +6791,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6716,7 +6852,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6744,7 +6881,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6770,7 +6908,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6786,7 +6925,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6843,7 +6983,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6857,7 +6998,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6879,7 +7021,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6895,7 +7038,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6935,7 +7079,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -6980,7 +7125,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7017,7 +7163,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7057,7 +7204,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7111,7 +7259,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7144,7 +7293,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7196,7 +7346,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7275,7 +7426,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7379,7 +7531,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7509,7 +7662,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -7999,7 +8153,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8015,6 +8170,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8109,7 +8265,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8186,7 +8342,8 @@ "merchantAccount", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8236,7 +8393,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8252,7 +8410,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -8271,7 +8430,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8385,7 +8545,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8418,7 +8579,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8481,7 +8643,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -8958,7 +9121,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -8969,6 +9133,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9102,7 +9269,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9135,7 +9303,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9464,7 +9633,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9480,7 +9650,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9492,7 +9663,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9590,7 +9762,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9632,7 +9805,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9669,7 +9843,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9727,7 +9902,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9750,7 +9926,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9774,7 +9951,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9802,7 +9980,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9838,7 +10017,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10100,7 +10280,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10152,7 +10333,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10168,7 +10350,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10176,7 +10359,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10192,7 +10376,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10200,7 +10385,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10220,7 +10406,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10260,7 +10447,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10299,7 +10487,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10332,7 +10521,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10348,7 +10538,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10379,7 +10570,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10395,7 +10587,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10435,7 +10628,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10453,7 +10647,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10486,7 +10681,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10502,7 +10698,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10549,7 +10746,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10589,7 +10787,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10623,7 +10822,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10734,7 +10934,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10776,7 +10977,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10832,7 +11034,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10868,7 +11071,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -10910,7 +11114,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -10943,7 +11148,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -10976,7 +11182,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11004,7 +11211,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11019,7 +11227,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11039,7 +11248,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11070,7 +11280,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11225,7 +11436,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11311,7 +11522,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15758,7 +15969,7 @@ "cvc" : "737" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "accountInfo" : { "accountCreationDate" : "2019-01-17T13:42:40+01:00" @@ -15783,7 +15994,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15825,7 +16036,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15867,7 +16084,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16016,8 +16239,7 @@ "encryptedCardNumber" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryMonth" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", "encryptedExpiryYear" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH...", - "storeDetails" : true + "encryptedSecurityCode" : "adyenjs_0_1_18$MT6ppy0FAMVMLH..." }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -16038,8 +16260,7 @@ "expiryMonth" : "03", "expiryYear" : "2030", "holderName" : "John Smith", - "cvc" : "737", - "storeDetails" : true + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "returnUrl" : "https://your-company.com/...", @@ -16172,7 +16393,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16201,24 +16422,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16236,7 +16457,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16270,6 +16491,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index b039459..d83e4dd 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v50/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v50/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=50) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:16Z", + "x-timestamp" : "2023-02-20T18:22:17Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2171,6 +2173,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3222,7 +3226,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3271,7 +3276,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3306,7 +3312,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3425,7 +3432,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3521,7 +3529,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3529,6 +3538,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3555,6 +3568,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3595,7 +3612,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3667,7 +3685,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3739,7 +3758,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3815,7 +3835,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3823,7 +3844,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3859,7 +3881,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3875,7 +3898,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3963,7 +3987,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4027,7 +4052,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4071,7 +4097,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4111,7 +4138,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4139,7 +4167,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4177,7 +4206,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4220,7 +4250,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4238,7 +4269,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4257,7 +4289,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4271,7 +4304,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4312,7 +4346,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4323,7 +4358,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4351,7 +4387,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4368,7 +4405,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4394,7 +4432,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4436,7 +4475,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4460,7 +4500,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4489,7 +4530,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4551,7 +4593,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4607,7 +4650,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4619,7 +4663,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4717,12 +4762,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4753,7 +4794,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4764,7 +4806,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4782,7 +4825,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4809,7 +4853,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5091,10 +5136,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5160,7 +5204,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5176,7 +5221,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5195,7 +5241,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5220,7 +5267,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5298,7 +5346,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5314,7 +5406,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5345,7 +5438,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5376,7 +5470,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5414,7 +5509,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5449,7 +5545,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5480,7 +5577,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5511,7 +5609,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5525,7 +5624,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5537,7 +5637,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5628,7 +5729,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5640,7 +5742,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5668,7 +5771,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5695,7 +5799,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5716,7 +5821,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5751,7 +5857,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5766,7 +5873,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5800,7 +5908,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5816,6 +5925,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5910,7 +6020,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5947,7 +6057,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5992,7 +6103,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6007,7 +6119,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6027,7 +6140,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6048,7 +6162,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6076,7 +6191,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6115,7 +6231,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6152,7 +6269,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6173,7 +6291,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6201,7 +6320,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6238,7 +6358,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6254,7 +6375,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6312,7 +6434,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6335,7 +6458,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6354,7 +6478,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6390,7 +6515,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6416,7 +6542,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6456,7 +6583,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6489,7 +6617,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6542,7 +6671,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6551,7 +6681,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6563,7 +6694,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6575,7 +6707,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6587,7 +6720,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6634,7 +6768,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6683,7 +6818,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6743,7 +6879,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6771,7 +6908,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6797,7 +6935,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6813,7 +6952,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6870,7 +7010,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6884,7 +7025,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6906,7 +7048,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6922,7 +7065,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6962,7 +7106,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7007,7 +7152,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7044,7 +7190,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7084,7 +7231,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7138,7 +7286,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7171,7 +7320,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7223,7 +7373,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7302,7 +7453,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7406,7 +7558,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7536,7 +7689,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8032,7 +8186,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8048,6 +8203,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8142,7 +8298,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8224,7 +8380,8 @@ "merchantAccount", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8274,7 +8431,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8290,7 +8448,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -8309,7 +8468,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8423,7 +8583,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8456,7 +8617,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8519,7 +8681,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9002,7 +9165,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9013,6 +9177,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9146,7 +9313,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9179,7 +9347,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9514,7 +9683,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9530,7 +9700,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9542,7 +9713,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9640,7 +9812,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9682,7 +9855,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9719,7 +9893,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9777,7 +9952,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9800,7 +9976,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9824,7 +10001,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9852,7 +10030,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9888,7 +10067,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10150,7 +10330,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10202,7 +10383,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10218,7 +10400,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10226,7 +10409,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10242,7 +10426,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10250,7 +10435,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10270,7 +10456,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10310,7 +10497,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10349,7 +10537,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10382,7 +10571,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10398,7 +10588,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10429,7 +10620,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10445,7 +10637,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10485,7 +10678,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10503,7 +10697,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10536,7 +10731,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10552,7 +10748,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10599,7 +10796,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10639,7 +10837,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10673,7 +10872,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10799,7 +10999,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10846,7 +11047,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10902,7 +11104,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10938,7 +11141,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -10980,7 +11184,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11013,7 +11218,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11046,7 +11252,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11074,7 +11281,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11089,7 +11297,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11109,7 +11318,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11140,7 +11350,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11295,7 +11506,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11381,7 +11592,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15828,7 +16039,7 @@ "cvc" : "737" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "accountInfo" : { "accountCreationDate" : "2019-01-17T13:42:40+01:00" @@ -15853,7 +16064,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15895,7 +16106,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15937,7 +16154,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16246,7 +16469,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16275,24 +16498,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16310,7 +16533,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16346,6 +16569,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index fee52c5..b8524b7 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v51/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v51/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=51) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:16Z", + "x-timestamp" : "2023-02-20T18:22:17Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3213,7 +3217,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3262,7 +3267,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3297,7 +3303,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3416,7 +3423,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3512,7 +3520,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3520,6 +3529,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3546,6 +3559,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3586,7 +3603,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3658,7 +3676,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3730,7 +3749,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3806,7 +3826,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3814,7 +3835,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3850,7 +3872,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3866,7 +3889,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3954,7 +3978,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4018,7 +4043,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4062,7 +4088,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4102,7 +4129,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4130,7 +4158,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4168,7 +4197,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4211,7 +4241,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4229,7 +4260,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4248,7 +4280,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4262,7 +4295,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4303,7 +4337,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4314,7 +4349,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4342,7 +4378,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4359,7 +4396,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4385,7 +4423,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4427,7 +4466,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4451,7 +4491,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4480,7 +4521,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4542,7 +4584,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4598,7 +4641,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4610,7 +4654,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4708,12 +4753,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4744,7 +4785,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4755,7 +4797,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4773,7 +4816,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4800,7 +4844,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5088,10 +5133,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5157,7 +5201,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5173,7 +5218,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5192,7 +5238,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5217,7 +5264,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5295,7 +5343,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5311,7 +5403,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5342,7 +5435,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5373,7 +5467,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5411,7 +5506,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5446,7 +5542,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5477,7 +5574,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5508,7 +5606,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5522,7 +5621,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5534,7 +5634,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5625,7 +5726,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5637,7 +5739,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5665,7 +5768,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5692,7 +5796,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5713,7 +5818,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5748,7 +5854,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5763,7 +5870,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5797,7 +5905,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5813,6 +5922,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5907,7 +6017,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5944,7 +6054,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5989,7 +6100,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6004,7 +6116,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6024,7 +6137,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6045,7 +6159,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6073,7 +6188,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6112,7 +6228,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6149,7 +6266,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6170,7 +6288,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6198,7 +6317,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6235,7 +6355,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6251,7 +6372,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6309,7 +6431,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6332,7 +6455,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6351,7 +6475,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6387,7 +6512,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6413,7 +6539,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6453,7 +6580,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6486,7 +6614,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6539,7 +6668,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6548,7 +6678,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6560,7 +6691,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6572,7 +6704,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6584,7 +6717,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6631,7 +6765,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6680,7 +6815,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6740,7 +6876,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6768,7 +6905,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6794,7 +6932,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6810,7 +6949,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6867,7 +7007,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6881,7 +7022,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6903,7 +7045,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6919,7 +7062,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6959,7 +7103,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7004,7 +7149,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7041,7 +7187,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7081,7 +7228,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7135,7 +7283,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7168,7 +7317,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7220,7 +7370,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7299,7 +7450,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7403,7 +7555,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7533,7 +7686,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8035,7 +8189,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8051,6 +8206,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8151,7 +8307,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8234,7 +8390,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8284,7 +8441,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8300,7 +8458,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -8319,7 +8478,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8439,7 +8599,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8472,7 +8633,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8535,7 +8697,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9024,7 +9187,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9035,6 +9199,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9168,7 +9335,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9201,7 +9369,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9542,7 +9711,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9558,7 +9728,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9570,7 +9741,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9668,7 +9840,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9710,7 +9883,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9747,7 +9921,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9805,7 +9980,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9828,7 +10004,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9852,7 +10029,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9880,7 +10058,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9916,7 +10095,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10178,7 +10358,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10230,7 +10411,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10246,7 +10428,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10254,7 +10437,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10270,7 +10454,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10278,7 +10463,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10298,7 +10484,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10338,7 +10525,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10377,7 +10565,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10410,7 +10599,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10426,7 +10616,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10457,7 +10648,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10473,7 +10665,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10513,7 +10706,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10531,7 +10725,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10564,7 +10759,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10580,7 +10776,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10627,7 +10824,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10667,7 +10865,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10701,7 +10900,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10827,7 +11027,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10874,7 +11075,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10930,7 +11132,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10966,7 +11169,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11008,7 +11212,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11041,7 +11246,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11074,7 +11280,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11102,7 +11309,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11117,7 +11325,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11137,7 +11346,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11168,7 +11378,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11323,7 +11534,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11409,7 +11620,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15856,7 +16067,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -15878,7 +16089,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15902,7 +16113,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16214,7 +16431,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16243,24 +16460,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16278,7 +16495,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16314,6 +16531,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 525be24..7a9e19a 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v52/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v52/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=52) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:16Z", + "x-timestamp" : "2023-02-20T18:22:18Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3213,7 +3217,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3262,7 +3267,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3297,7 +3303,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3416,7 +3423,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3512,7 +3520,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3520,6 +3529,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3546,6 +3559,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3586,7 +3603,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3658,7 +3676,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3730,7 +3749,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3806,7 +3826,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3814,7 +3835,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3850,7 +3872,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3866,7 +3889,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3954,7 +3978,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4018,7 +4043,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4062,7 +4088,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4102,7 +4129,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4130,7 +4158,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4168,7 +4197,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4211,7 +4241,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4229,7 +4260,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4248,7 +4280,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4262,7 +4295,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4303,7 +4337,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4314,7 +4349,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4342,7 +4378,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4359,7 +4396,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4385,7 +4423,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4427,7 +4466,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4451,7 +4491,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4480,7 +4521,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4542,7 +4584,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4598,7 +4641,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4610,7 +4654,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4708,12 +4753,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4744,7 +4785,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4755,7 +4797,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4773,7 +4816,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4800,7 +4844,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5088,10 +5133,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5157,7 +5201,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5173,7 +5218,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5192,7 +5238,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5217,7 +5264,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5295,7 +5343,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5311,7 +5403,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5342,7 +5435,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5373,7 +5467,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5411,7 +5506,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5446,7 +5542,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5477,7 +5574,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5508,7 +5606,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5522,7 +5621,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5534,7 +5634,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5625,7 +5726,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5637,7 +5739,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5665,7 +5768,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5692,7 +5796,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5713,7 +5818,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5748,7 +5854,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5763,7 +5870,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5797,7 +5905,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5813,6 +5922,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5907,7 +6017,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5944,7 +6054,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5989,7 +6100,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6004,7 +6116,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6024,7 +6137,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6045,7 +6159,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6073,7 +6188,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6112,7 +6228,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6149,7 +6266,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6170,7 +6288,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6198,7 +6317,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6235,7 +6355,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6251,7 +6372,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6309,7 +6431,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6332,7 +6455,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6351,7 +6475,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6387,7 +6512,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6413,7 +6539,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6453,7 +6580,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6486,7 +6614,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6539,7 +6668,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6548,7 +6678,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6560,7 +6691,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6572,7 +6704,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6584,7 +6717,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6631,7 +6765,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6680,7 +6815,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6740,7 +6876,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6768,7 +6905,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6794,7 +6932,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6810,7 +6949,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6867,7 +7007,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6881,7 +7022,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6903,7 +7045,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6919,7 +7062,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6959,7 +7103,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7004,7 +7149,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7041,7 +7187,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7081,7 +7228,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7135,7 +7283,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7168,7 +7317,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7220,7 +7370,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7299,7 +7450,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7403,7 +7555,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7538,7 +7691,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8040,7 +8194,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8056,6 +8211,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8156,7 +8312,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8239,7 +8395,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8289,7 +8446,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8305,7 +8463,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -8324,7 +8483,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8444,7 +8604,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8477,7 +8638,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8540,7 +8702,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9029,7 +9192,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9040,6 +9204,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9178,7 +9345,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9211,7 +9379,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9552,7 +9721,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9568,7 +9738,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9580,7 +9751,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9678,7 +9850,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9720,7 +9893,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9757,7 +9931,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9815,7 +9990,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9838,7 +10014,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9862,7 +10039,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9890,7 +10068,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9926,7 +10105,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10188,7 +10368,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10240,7 +10421,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10256,7 +10438,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10264,7 +10447,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10280,7 +10464,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10288,7 +10473,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10308,7 +10494,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10348,7 +10535,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10387,7 +10575,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10420,7 +10609,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10436,7 +10626,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10467,7 +10658,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10483,7 +10675,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10523,7 +10716,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10541,7 +10735,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10574,7 +10769,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10590,7 +10786,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10637,7 +10834,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10677,7 +10875,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10711,7 +10910,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10837,7 +11037,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10884,7 +11085,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10940,7 +11142,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10976,7 +11179,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11018,7 +11222,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11051,7 +11256,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11084,7 +11290,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11112,7 +11319,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11127,7 +11335,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11147,7 +11356,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11178,7 +11388,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11333,7 +11544,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11419,7 +11630,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15866,7 +16077,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -15888,7 +16099,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15912,7 +16123,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16224,7 +16441,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16253,24 +16470,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16288,7 +16505,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16324,6 +16541,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index fd3f9d6..f0265e0 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v53/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v53/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=53) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:17Z", + "x-timestamp" : "2023-02-20T18:22:18Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3213,7 +3217,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3262,7 +3267,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3297,7 +3303,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3416,7 +3423,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3512,7 +3520,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3520,6 +3529,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3546,6 +3559,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3586,7 +3603,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3658,7 +3676,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3730,7 +3749,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3806,7 +3826,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3814,7 +3835,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3850,7 +3872,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3866,7 +3889,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3954,7 +3978,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4018,7 +4043,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4062,7 +4088,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4102,7 +4129,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4130,7 +4158,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4168,7 +4197,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4211,7 +4241,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4229,7 +4260,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4248,7 +4280,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4262,7 +4295,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4303,7 +4337,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4314,7 +4349,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4342,7 +4378,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4359,7 +4396,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4385,7 +4423,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4427,7 +4466,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4451,7 +4491,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4480,7 +4521,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4542,7 +4584,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4598,7 +4641,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4610,7 +4654,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4708,12 +4753,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4744,7 +4785,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4755,7 +4797,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4773,7 +4816,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4800,7 +4844,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5088,10 +5133,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5157,7 +5201,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5173,7 +5218,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5192,7 +5238,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5217,7 +5264,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5295,7 +5343,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5311,7 +5403,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5342,7 +5435,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5373,7 +5467,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5411,7 +5506,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5446,7 +5542,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5477,7 +5574,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5508,7 +5606,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5522,7 +5621,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5534,7 +5634,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5625,7 +5726,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5637,7 +5739,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5665,7 +5768,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5692,7 +5796,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5713,7 +5818,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5748,7 +5854,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5763,7 +5870,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5797,7 +5905,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5813,6 +5922,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5907,7 +6017,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5944,7 +6054,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5989,7 +6100,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6004,7 +6116,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6024,7 +6137,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6045,7 +6159,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6073,7 +6188,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6112,7 +6228,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6149,7 +6266,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6170,7 +6288,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6198,7 +6317,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6235,7 +6355,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6251,7 +6372,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6309,7 +6431,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6332,7 +6455,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6351,7 +6475,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6387,7 +6512,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6413,7 +6539,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6453,7 +6580,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6486,7 +6614,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6539,7 +6668,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6548,7 +6678,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6560,7 +6691,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6572,7 +6704,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6584,7 +6717,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6631,7 +6765,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6680,7 +6815,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6740,7 +6876,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6768,7 +6905,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6794,7 +6932,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6810,7 +6949,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6867,7 +7007,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6881,7 +7022,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6903,7 +7045,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6919,7 +7062,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6959,7 +7103,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7004,7 +7149,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7041,7 +7187,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7081,7 +7228,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7135,7 +7283,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7168,7 +7317,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7220,7 +7370,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7299,7 +7450,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7403,7 +7555,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7538,7 +7691,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8040,7 +8194,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8056,6 +8211,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8156,7 +8312,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8239,7 +8395,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8297,7 +8454,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8313,7 +8471,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -8332,7 +8491,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8458,7 +8618,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8491,7 +8652,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8554,7 +8716,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9043,7 +9206,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9054,6 +9218,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9192,7 +9359,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9225,7 +9393,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9566,7 +9735,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9582,7 +9752,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9594,7 +9765,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9692,7 +9864,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9734,7 +9907,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9771,7 +9945,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9837,7 +10012,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9860,7 +10036,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9884,7 +10061,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9912,7 +10090,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9948,7 +10127,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10210,7 +10390,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10262,7 +10443,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10278,7 +10460,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10286,7 +10469,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10302,7 +10486,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10310,7 +10495,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10330,7 +10516,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10370,7 +10557,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10409,7 +10597,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10442,7 +10631,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10458,7 +10648,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10489,7 +10680,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10505,7 +10697,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10545,7 +10738,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10563,7 +10757,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10596,7 +10791,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10612,7 +10808,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10659,7 +10856,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10699,7 +10897,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10733,7 +10932,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10859,7 +11059,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10906,7 +11107,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -10962,7 +11164,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -10998,7 +11201,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11040,7 +11244,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11073,7 +11278,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11106,7 +11312,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11134,7 +11341,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11149,7 +11357,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11169,7 +11378,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11200,7 +11410,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11355,7 +11566,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11441,7 +11652,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15888,7 +16099,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -15910,7 +16121,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15934,7 +16145,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16246,7 +16463,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16275,24 +16492,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16310,7 +16527,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16346,6 +16563,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index 70ff1f9..10fda24 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v64/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v64/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=64) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:17Z", + "x-timestamp" : "2023-02-20T18:22:18Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3213,7 +3217,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3262,7 +3267,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3297,7 +3303,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3416,7 +3423,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3512,7 +3520,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3520,6 +3529,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3546,6 +3559,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3586,7 +3603,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3658,7 +3676,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3730,7 +3749,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3806,7 +3826,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3814,7 +3835,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3850,7 +3872,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3866,7 +3889,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3954,7 +3978,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4018,7 +4043,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4062,7 +4088,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4102,7 +4129,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4130,7 +4158,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4168,7 +4197,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4211,7 +4241,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4229,7 +4260,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4248,7 +4280,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4262,7 +4295,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4303,7 +4337,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4314,7 +4349,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4342,7 +4378,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4359,7 +4396,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4385,7 +4423,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4427,7 +4466,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4451,7 +4491,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4480,7 +4521,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4542,7 +4584,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4598,7 +4641,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4610,7 +4654,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4708,12 +4753,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4744,7 +4785,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4755,7 +4797,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4773,7 +4816,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4800,7 +4844,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5088,10 +5133,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5157,7 +5201,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5173,7 +5218,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5192,7 +5238,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5217,7 +5264,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5295,7 +5343,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5311,7 +5403,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5342,7 +5435,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5373,7 +5467,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5411,7 +5506,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5446,7 +5542,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5477,7 +5574,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5508,7 +5606,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5522,7 +5621,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5534,7 +5634,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5625,7 +5726,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5637,7 +5739,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5665,7 +5768,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5692,7 +5796,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5713,7 +5818,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5748,7 +5854,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5763,7 +5870,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5797,7 +5905,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5813,6 +5922,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5907,7 +6017,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5944,7 +6054,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5989,7 +6100,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6004,7 +6116,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6024,7 +6137,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6045,7 +6159,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6073,7 +6188,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6112,7 +6228,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6149,7 +6266,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6170,7 +6288,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6198,7 +6317,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6235,7 +6355,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6251,7 +6372,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6309,7 +6431,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6332,7 +6455,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6351,7 +6475,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6387,7 +6512,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6413,7 +6539,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6453,7 +6580,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6486,7 +6614,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6539,7 +6668,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6575,7 +6705,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6596,7 +6727,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6608,7 +6740,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6620,7 +6753,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6667,7 +6801,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6716,7 +6851,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6776,7 +6912,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6804,7 +6941,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6830,7 +6968,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6846,7 +6985,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6903,7 +7043,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6917,7 +7058,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6939,7 +7081,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6955,7 +7098,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -6995,7 +7139,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7040,7 +7185,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7077,7 +7223,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7117,7 +7264,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7171,7 +7319,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7204,7 +7353,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7256,7 +7406,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7335,7 +7486,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7439,7 +7591,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7588,7 +7741,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8090,7 +8244,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8106,6 +8261,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8206,7 +8362,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8289,7 +8445,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8347,7 +8504,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8363,7 +8521,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsGroup" : { "properties" : { @@ -8382,7 +8541,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8513,7 +8673,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8546,7 +8707,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8609,7 +8771,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9098,7 +9261,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9109,6 +9273,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9261,7 +9428,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9294,7 +9462,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9635,7 +9804,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9651,7 +9821,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9663,7 +9834,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9761,7 +9933,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9803,7 +9976,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9840,7 +10014,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9906,7 +10081,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9929,7 +10105,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9953,7 +10130,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9981,7 +10159,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -10017,7 +10196,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10279,7 +10459,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10331,7 +10512,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10347,7 +10529,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10355,7 +10538,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10371,7 +10555,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10379,7 +10564,8 @@ "description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10399,7 +10585,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10439,7 +10626,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10478,7 +10666,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10511,7 +10700,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10527,7 +10717,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10558,7 +10749,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10574,7 +10766,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10614,7 +10807,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10632,7 +10826,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10665,7 +10860,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10681,7 +10877,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10728,7 +10925,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10768,7 +10966,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10802,7 +11001,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10928,7 +11128,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10975,7 +11176,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -11031,7 +11233,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -11067,7 +11270,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11109,7 +11313,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11142,7 +11347,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11175,7 +11381,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11203,7 +11410,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11218,7 +11426,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11238,7 +11447,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11269,7 +11479,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11424,7 +11635,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11510,7 +11721,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15957,7 +16168,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -15979,7 +16190,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16003,7 +16214,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16315,7 +16532,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16344,24 +16561,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16379,7 +16596,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16415,6 +16632,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index 18d70f4..87301ac 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v65/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v65/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=65) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:17Z", + "x-timestamp" : "2023-02-20T18:22:18Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3213,7 +3217,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3262,7 +3267,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3297,7 +3303,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3416,7 +3423,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3512,7 +3520,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3520,6 +3529,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3546,6 +3559,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3586,7 +3603,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3658,7 +3676,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3730,7 +3749,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3806,7 +3826,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3814,7 +3835,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3850,7 +3872,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3866,7 +3889,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3954,7 +3978,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4018,7 +4043,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4062,7 +4088,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4102,7 +4129,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4130,7 +4158,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4168,7 +4197,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4211,7 +4241,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4229,7 +4260,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4248,7 +4280,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4262,7 +4295,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4303,7 +4337,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4314,7 +4349,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4342,7 +4378,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4359,7 +4396,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4400,7 +4438,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4442,7 +4481,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4466,7 +4506,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4495,7 +4536,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4557,7 +4599,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4613,7 +4656,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4625,7 +4669,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4723,12 +4768,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4759,7 +4800,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4770,7 +4812,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4788,7 +4831,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4815,7 +4859,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5097,10 +5142,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5171,7 +5215,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5187,7 +5232,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5206,7 +5252,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5231,7 +5278,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5309,7 +5357,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5325,7 +5417,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5356,7 +5449,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5387,7 +5481,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5425,7 +5520,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5460,7 +5556,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5491,7 +5588,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5522,7 +5620,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5536,7 +5635,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5548,7 +5648,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5639,7 +5740,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5651,7 +5753,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5679,7 +5782,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5706,7 +5810,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5727,7 +5832,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5762,7 +5868,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5777,7 +5884,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5811,7 +5919,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5827,6 +5936,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5926,7 +6036,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5963,7 +6073,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -6008,7 +6119,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6023,7 +6135,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6043,7 +6156,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6064,7 +6178,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6092,7 +6207,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6131,7 +6247,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6168,7 +6285,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6189,7 +6307,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6217,7 +6336,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6254,7 +6374,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6270,7 +6391,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6328,7 +6450,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6351,7 +6474,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6370,7 +6494,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6406,7 +6531,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6432,7 +6558,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6472,7 +6599,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6505,7 +6633,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6558,7 +6687,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6594,7 +6724,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6615,7 +6746,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6627,7 +6759,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6639,7 +6772,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6686,7 +6820,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6735,7 +6870,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6795,7 +6931,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6823,7 +6960,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6849,7 +6987,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6865,7 +7004,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6922,7 +7062,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6936,7 +7077,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6958,7 +7100,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6974,7 +7117,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -7014,7 +7158,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7059,7 +7204,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7096,7 +7242,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7136,7 +7283,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7190,7 +7338,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7223,7 +7372,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7275,7 +7425,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7354,7 +7505,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7458,7 +7610,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7607,7 +7760,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8103,7 +8257,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8119,6 +8274,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8224,7 +8380,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8307,7 +8463,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8366,7 +8523,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8382,7 +8540,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8507,7 +8666,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8526,7 +8686,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8589,7 +8750,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9072,7 +9234,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9083,6 +9246,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9235,7 +9401,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9268,7 +9435,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9603,7 +9771,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9619,7 +9788,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9631,7 +9801,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9729,7 +9900,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9771,7 +9943,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9808,7 +9981,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9875,7 +10049,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9898,7 +10073,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9922,7 +10098,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9950,7 +10127,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9986,7 +10164,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10240,7 +10419,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10292,7 +10472,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10308,7 +10489,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10316,7 +10498,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10332,7 +10515,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10359,7 +10543,8 @@ "description" : "The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10379,7 +10564,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10419,7 +10605,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10458,7 +10645,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10491,7 +10679,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10507,7 +10696,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10538,7 +10728,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10554,7 +10745,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10594,7 +10786,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10612,7 +10805,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10645,7 +10839,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10661,7 +10856,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10708,7 +10904,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10748,7 +10945,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10782,7 +10980,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10908,7 +11107,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10955,7 +11155,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -11011,7 +11212,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -11047,7 +11249,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11089,7 +11292,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11122,7 +11326,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11155,7 +11360,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11183,7 +11389,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11198,7 +11405,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11218,7 +11426,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11249,7 +11458,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11406,7 +11616,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11492,7 +11702,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15939,7 +16149,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -15961,7 +16171,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15985,7 +16195,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16297,7 +16513,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16326,24 +16542,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16361,7 +16577,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16397,6 +16613,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 81ac594..8856071 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v66/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v66/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=66) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:18Z", + "x-timestamp" : "2023-02-20T18:22:19Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -775,7 +775,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -919,7 +919,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1642,6 +1642,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3213,7 +3217,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3262,7 +3267,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3297,7 +3303,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3416,7 +3423,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3512,7 +3520,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3520,6 +3529,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3546,6 +3559,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3586,7 +3603,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3658,7 +3676,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3730,7 +3749,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3806,7 +3826,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3814,7 +3835,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3850,7 +3872,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3866,7 +3889,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3954,7 +3978,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4018,7 +4043,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4062,7 +4088,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4102,7 +4129,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4130,7 +4158,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4168,7 +4197,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4211,7 +4241,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4229,7 +4260,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4248,7 +4280,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4262,7 +4295,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4303,7 +4337,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4314,7 +4349,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4342,7 +4378,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4359,7 +4396,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4400,7 +4438,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4442,7 +4481,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4466,7 +4506,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4495,7 +4536,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4557,7 +4599,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4613,7 +4656,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4625,7 +4669,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4723,12 +4768,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4759,7 +4800,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4770,7 +4812,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4788,7 +4831,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4815,7 +4859,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5097,10 +5142,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5171,7 +5215,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5187,7 +5232,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5206,7 +5252,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5231,7 +5278,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5309,7 +5357,51 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentData" : { + "description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5325,7 +5417,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5356,7 +5449,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5387,7 +5481,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5425,7 +5520,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5460,7 +5556,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2ChallengeAction" : { "additionalProperties" : false, @@ -5491,7 +5588,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2FingerPrintAction" : { "additionalProperties" : false, @@ -5522,7 +5620,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5536,7 +5635,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5548,7 +5648,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5639,7 +5740,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5651,7 +5753,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5679,7 +5782,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5706,7 +5810,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5727,7 +5832,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5762,7 +5868,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5777,7 +5884,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5811,7 +5919,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5827,6 +5936,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5926,7 +6036,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5963,7 +6073,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -6008,7 +6119,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6023,7 +6135,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6043,7 +6156,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6064,7 +6178,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6092,7 +6207,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6131,7 +6247,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6168,7 +6285,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6189,7 +6307,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6217,7 +6336,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6254,7 +6374,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6270,7 +6391,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6328,7 +6450,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6351,7 +6474,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6370,7 +6494,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6406,7 +6531,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6432,7 +6558,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6472,7 +6599,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6505,7 +6633,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6558,7 +6687,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6594,7 +6724,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6615,7 +6746,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6627,7 +6759,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6639,7 +6772,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6686,7 +6820,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6735,7 +6870,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6795,7 +6931,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6823,7 +6960,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6849,7 +6987,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6865,7 +7004,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6922,7 +7062,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6936,7 +7077,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6958,7 +7100,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6974,7 +7117,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -7014,7 +7158,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7059,7 +7204,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7096,7 +7242,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7136,7 +7283,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7190,7 +7338,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7223,7 +7372,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7275,7 +7425,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7354,7 +7505,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7458,7 +7610,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7612,7 +7765,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8108,7 +8262,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8124,6 +8279,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8229,7 +8385,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8312,7 +8468,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8371,7 +8528,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8387,7 +8545,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8512,7 +8671,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8531,7 +8691,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8594,7 +8755,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9077,7 +9239,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9088,6 +9251,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9245,7 +9411,8 @@ "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9278,7 +9445,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9613,7 +9781,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9629,7 +9798,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9641,7 +9811,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9739,7 +9910,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9781,7 +9953,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9818,7 +9991,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9885,7 +10059,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "Redirect" : { "properties" : { @@ -9908,7 +10083,8 @@ "description" : "The URL, to which you must redirect a shopper to complete a payment.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9932,7 +10108,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9960,7 +10137,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9996,7 +10174,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10250,7 +10429,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10302,7 +10482,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10318,7 +10499,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10326,7 +10508,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10342,7 +10525,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10369,7 +10553,8 @@ "description" : "The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10389,7 +10574,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10429,7 +10615,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10468,7 +10655,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10501,7 +10689,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10517,7 +10706,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10548,7 +10738,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10564,7 +10755,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10604,7 +10796,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10622,7 +10815,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10655,7 +10849,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10671,7 +10866,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10718,7 +10914,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10758,7 +10955,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10792,7 +10990,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10918,7 +11117,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10965,7 +11165,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -11021,7 +11222,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -11057,7 +11259,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11099,7 +11302,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11132,7 +11336,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11165,7 +11370,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11193,7 +11399,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11208,7 +11415,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11228,7 +11436,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11259,7 +11468,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11416,7 +11626,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11502,7 +11712,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15949,7 +16159,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -15971,7 +16181,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -15995,7 +16205,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16307,7 +16523,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16336,24 +16552,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16371,7 +16587,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16407,6 +16623,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index bdd05c8..568220d 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v67/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v67/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=67) to find out what changed in this version!", - "x-timestamp" : "2023-02-08T17:21:18Z", + "x-timestamp" : "2023-02-20T18:22:19Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -777,7 +777,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -921,7 +921,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1644,6 +1644,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2158,6 +2160,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3209,7 +3213,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3258,7 +3263,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3293,7 +3299,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3412,7 +3419,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3508,7 +3516,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3516,6 +3525,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3542,6 +3555,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3582,7 +3599,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3654,7 +3672,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3726,7 +3745,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -3802,7 +3822,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -3810,7 +3831,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -3846,7 +3868,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -3862,7 +3885,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -3950,7 +3974,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4014,7 +4039,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4058,7 +4084,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4098,7 +4125,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4126,7 +4154,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4164,7 +4193,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4207,7 +4237,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4225,7 +4256,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4244,7 +4276,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4258,7 +4291,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4299,7 +4333,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4310,7 +4345,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4338,7 +4374,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4355,7 +4392,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4396,7 +4434,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4438,7 +4477,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4462,7 +4502,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4491,7 +4532,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4553,7 +4595,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4609,7 +4652,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4621,7 +4665,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4719,12 +4764,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -4755,7 +4796,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -4766,7 +4808,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -4784,7 +4827,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -4811,7 +4855,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5093,10 +5138,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5167,7 +5211,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5183,7 +5228,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5202,7 +5248,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5227,7 +5274,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5305,7 +5353,47 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5321,7 +5409,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5352,7 +5441,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5383,7 +5473,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5417,7 +5508,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5452,7 +5544,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutThreeDS2Action" : { "additionalProperties" : false, @@ -5491,7 +5584,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5505,7 +5599,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5517,7 +5612,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5608,7 +5704,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5620,7 +5717,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5648,7 +5746,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5675,7 +5774,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5696,7 +5796,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -5731,7 +5832,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -5746,7 +5848,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -5780,7 +5883,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -5796,6 +5900,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -5910,7 +6015,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -5952,7 +6057,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -5997,7 +6103,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6012,7 +6119,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6032,7 +6140,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6053,7 +6162,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -6081,7 +6191,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -6120,7 +6231,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -6157,7 +6269,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -6178,7 +6291,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -6206,7 +6320,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -6243,7 +6358,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -6259,7 +6375,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -6317,7 +6434,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -6340,7 +6458,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -6359,7 +6478,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -6395,7 +6515,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -6421,7 +6542,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -6461,7 +6583,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -6494,7 +6617,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -6547,7 +6671,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -6583,7 +6708,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -6604,7 +6730,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -6616,7 +6743,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -6628,7 +6756,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -6675,7 +6804,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -6724,7 +6854,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -6784,7 +6915,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -6812,7 +6944,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -6838,7 +6971,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -6854,7 +6988,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -6911,7 +7046,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -6925,7 +7061,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -6947,7 +7084,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -6963,7 +7101,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -7003,7 +7142,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -7048,7 +7188,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -7085,7 +7226,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -7125,7 +7267,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -7179,7 +7322,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -7212,7 +7356,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -7264,7 +7409,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -7343,7 +7489,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -7447,7 +7594,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -7558,7 +7706,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -8054,7 +8203,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -8070,6 +8220,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -8190,7 +8341,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -8278,7 +8429,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -8337,7 +8489,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -8353,7 +8506,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -8478,7 +8632,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -8497,7 +8652,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -8560,7 +8716,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -9043,7 +9200,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -9054,6 +9212,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -9174,7 +9335,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -9207,7 +9369,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -9542,7 +9705,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -9558,7 +9722,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -9570,7 +9735,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -9668,7 +9834,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -9710,7 +9877,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -9747,7 +9915,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -9814,7 +9983,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -9838,7 +10008,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -9866,7 +10037,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -9902,7 +10074,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -10156,7 +10329,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -10208,7 +10382,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -10224,7 +10399,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -10232,7 +10408,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -10248,7 +10425,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -10275,7 +10453,8 @@ "description" : "The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -10295,7 +10474,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -10335,7 +10515,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -10374,7 +10555,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -10407,7 +10589,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -10423,7 +10606,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -10454,7 +10638,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -10470,7 +10655,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -10510,7 +10696,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -10528,7 +10715,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -10561,7 +10749,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -10577,7 +10766,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -10634,7 +10824,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -10674,7 +10865,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -10708,7 +10900,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -10834,7 +11027,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2ResponseData" : { "properties" : { @@ -10895,7 +11089,8 @@ "transStatusReason" : { "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -10983,7 +11178,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -11063,7 +11259,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -11099,7 +11296,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -11141,7 +11339,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -11174,7 +11373,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -11207,7 +11407,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -11235,7 +11436,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -11250,7 +11452,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -11270,7 +11473,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -11301,7 +11505,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -11458,7 +11663,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -11544,7 +11749,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -15991,7 +16196,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -16013,7 +16218,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16037,7 +16242,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -16074,11 +16285,11 @@ "cvcResultRaw" : "M", "refusalReasonRaw" : "AUTHORISED", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895204576J", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-card-securedfields" : { @@ -16111,11 +16322,11 @@ "cvcResultRaw" : "M", "refusalReasonRaw" : "AUTHORISED", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIE9N" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895215577D", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-details-3d-secure-2-native" : { @@ -16171,11 +16382,11 @@ "refusalReasonRaw" : "AUTHORISED", "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VC172" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895195570C", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-enableOneClick-raw" : { @@ -16216,11 +16427,11 @@ "refusalReasonRaw" : "AUTHORISED", "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895197573E", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-giropay" : { @@ -16243,7 +16454,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0", "paymentMethodType" : "giropay", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA", "method" : "GET", @@ -16299,7 +16509,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==", "paymentMethodType" : "ideal", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ", "method" : "GET", @@ -16328,7 +16537,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -16357,24 +16566,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -16392,7 +16601,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -16428,6 +16637,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", @@ -16463,7 +16673,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw==", "paymentMethodType" : "directEbanking", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA", "method" : "GET", @@ -16558,11 +16767,11 @@ "refusalReasonRaw" : "AUTHORISED", "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VD896" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895199574A", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } } } diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index 5213d56..c4d305c 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v68/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v68/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=68) to find out what changed in this version!", - "x-timestamp" : "2023-02-09T12:22:11Z", + "x-timestamp" : "2023-02-21T16:25:42Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -777,7 +777,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -921,7 +921,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1644,6 +1644,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2158,6 +2160,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3284,7 +3288,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AcctInfo" : { "properties" : { @@ -3409,7 +3414,8 @@ "maxLength" : 3, "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3463,7 +3469,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3498,7 +3505,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3617,7 +3625,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3713,7 +3722,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3721,6 +3731,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3747,6 +3761,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3787,7 +3805,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3859,7 +3878,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3931,7 +3951,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -4007,7 +4028,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -4015,7 +4037,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -4051,7 +4074,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -4067,7 +4091,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -4155,7 +4180,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4219,7 +4245,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4263,7 +4290,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4303,7 +4331,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4331,7 +4360,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4369,7 +4399,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4417,7 +4448,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4440,7 +4472,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4459,7 +4492,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4478,7 +4512,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4524,7 +4559,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4535,7 +4571,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4563,7 +4600,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4580,7 +4618,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4626,7 +4665,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4668,7 +4708,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4697,7 +4738,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4731,7 +4773,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4793,7 +4836,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4849,7 +4893,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4861,7 +4906,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -4964,12 +5010,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -5000,7 +5042,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -5011,7 +5054,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -5034,7 +5078,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -5061,7 +5106,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5351,10 +5397,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5425,7 +5470,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5441,7 +5487,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5460,7 +5507,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5485,7 +5533,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5569,7 +5618,47 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5585,7 +5674,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5616,7 +5706,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5652,7 +5743,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5686,7 +5778,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5721,7 +5814,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSessionInstallmentOption" : { "properties" : { @@ -5749,7 +5843,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CheckoutThreeDS2Action" : { "additionalProperties" : false, @@ -5788,7 +5883,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5802,7 +5898,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5814,7 +5911,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5905,7 +6003,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5917,7 +6016,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5945,7 +6045,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -5972,7 +6073,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -5993,7 +6095,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreateCheckoutSessionRequest" : { "properties" : { @@ -6301,7 +6404,8 @@ "reference", "returnUrl", "merchantAccount" - ] + ], + "type" : "object" }, "CreateCheckoutSessionResponse" : { "properties" : { @@ -6620,7 +6724,8 @@ "returnUrl", "expiresAt", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -6655,7 +6760,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -6670,7 +6776,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -6704,7 +6811,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -6720,6 +6828,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -6834,7 +6943,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -6886,7 +6995,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -6931,7 +7041,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -6946,7 +7057,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -6966,7 +7078,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -6987,7 +7100,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -7015,7 +7129,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -7059,7 +7174,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -7096,7 +7212,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -7122,7 +7239,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -7155,7 +7273,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -7197,7 +7316,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -7213,7 +7333,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -7271,7 +7392,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -7294,7 +7416,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -7313,7 +7436,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "FundOrigin" : { "properties" : { @@ -7325,7 +7449,8 @@ "description" : "The name of the person", "$ref" : "#/components/schemas/Name" } - } + }, + "type" : "object" }, "FundRecipient" : { "properties" : { @@ -7369,7 +7494,8 @@ "description" : "indicates the tax identifier of the fund recepient", "type" : "string" } - } + }, + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -7410,7 +7536,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -7441,7 +7568,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -7486,7 +7614,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -7524,7 +7653,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -7577,7 +7707,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -7613,7 +7744,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -7634,7 +7766,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -7646,7 +7779,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -7658,7 +7792,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -7710,7 +7845,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -7759,7 +7895,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -7819,7 +7956,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -7852,7 +7990,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -7883,7 +8022,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -7899,7 +8039,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -7985,7 +8126,8 @@ "description" : "Indicates shipping method chosen for the transaction.", "type" : "string" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -8004,7 +8146,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -8031,7 +8174,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -8047,7 +8191,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -8092,7 +8237,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -8142,7 +8288,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -8184,7 +8331,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -8229,7 +8377,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -8283,7 +8432,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -8316,7 +8466,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -8368,7 +8519,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -8447,7 +8599,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -8556,7 +8709,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -8667,7 +8821,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -9181,7 +9336,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -9197,6 +9353,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -9317,7 +9474,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -9415,7 +9572,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -9475,7 +9633,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -9491,7 +9650,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodIssuer" : { "properties" : { @@ -9512,7 +9672,8 @@ "required" : [ "id", "name" - ] + ], + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -9637,7 +9798,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -9656,7 +9818,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -9719,7 +9882,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -10220,7 +10384,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -10231,6 +10396,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -10351,7 +10519,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -10384,7 +10553,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -10737,7 +10907,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -10753,7 +10924,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -10765,7 +10937,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -10863,7 +11036,8 @@ "merchantReference", "paymentMethod", "shopperLocale" - ] + ], + "type" : "object" }, "Phone" : { "properties" : { @@ -10878,10 +11052,26 @@ "maxLength" : 15, "type" : "string" } - } + }, + "type" : "object" }, "PlatformChargebackLogic" : { - + "properties" : { + "behavior" : { + "x-addedInVersion" : "68", + "enum" : [ + "deductAccordingToSplitRatio", + "deductFromLiableAccount", + "deductFromOneBalanceAccount" + ], + "type" : "string" + }, + "targetAccount" : { + "x-addedInVersion" : "68", + "type" : "string" + } + }, + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -10928,7 +11118,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -10965,7 +11156,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -11033,7 +11225,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -11057,7 +11250,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -11085,7 +11279,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -11121,7 +11316,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -11375,7 +11571,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -11427,7 +11624,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -11443,7 +11641,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -11451,7 +11650,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -11467,7 +11667,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "RiskData" : { "properties" : { @@ -11494,7 +11695,8 @@ "description" : "The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -11514,7 +11716,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -11559,7 +11762,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -11603,7 +11807,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -11636,7 +11841,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -11652,7 +11858,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -11683,7 +11890,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -11699,7 +11907,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -11739,7 +11948,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -11757,7 +11967,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -11790,7 +12001,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -11806,7 +12018,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -11868,7 +12081,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -11913,7 +12127,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -11947,7 +12162,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "SubMerchant" : { "properties" : { @@ -11971,7 +12187,8 @@ "description" : "The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -12239,7 +12456,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2ResponseData" : { "properties" : { @@ -12300,7 +12518,8 @@ "transStatusReason" : { "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -12388,7 +12607,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorAuthenticationInfo" : { "properties" : { @@ -12416,7 +12636,8 @@ "minLength" : 12, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorPriorAuthenticationInfo" : { "properties" : { @@ -12448,7 +12669,8 @@ "minLength" : 36, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -12534,7 +12756,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -12570,7 +12793,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -12617,7 +12841,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -12655,7 +12880,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -12693,7 +12919,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -12726,7 +12953,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -12746,7 +12974,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -12771,7 +13000,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -12807,7 +13037,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -12964,7 +13195,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -13050,7 +13281,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -13082,6 +13313,10 @@ "remainingAmount" : { "currency" : "EUR", "value" : 2500 + }, + "amount" : { + "currency" : "EUR", + "value" : 300 } } }, @@ -17497,7 +17732,7 @@ "holderName" : "John Smith" }, "additionalData" : { - "allow3DS2" : true + "allow3DS2" : "true" }, "billingAddress" : { "country" : "US", @@ -17519,7 +17754,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -17543,7 +17778,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -17580,11 +17821,11 @@ "cvcResultRaw" : "M", "refusalReasonRaw" : "AUTHORISED", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895204576J", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-card-securedfields" : { @@ -17617,11 +17858,11 @@ "cvcResultRaw" : "M", "refusalReasonRaw" : "AUTHORISED", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIE9N" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895215577D", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-details-3d-secure-2-native" : { @@ -17677,11 +17918,11 @@ "refusalReasonRaw" : "AUTHORISED", "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VC172" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895195570C", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-enableOneClick-raw" : { @@ -17722,11 +17963,11 @@ "refusalReasonRaw" : "AUTHORISED", "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895197573E", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-payments-giropay" : { @@ -17749,7 +17990,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0", "paymentMethodType" : "giropay", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA", "method" : "GET", @@ -17805,7 +18045,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==", "paymentMethodType" : "ideal", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ", "method" : "GET", @@ -17834,7 +18073,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -17863,24 +18102,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -17898,7 +18137,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -17934,6 +18173,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", @@ -17969,7 +18209,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw==", "paymentMethodType" : "directEbanking", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA", "method" : "GET", @@ -18064,11 +18303,11 @@ "refusalReasonRaw" : "AUTHORISED", "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID", "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VD896" + "acquirerReference" : "YOUR_ACQUIRER_REFERENCE" }, - "pspReference" : "993617895199574A", + "pspReference" : "YOUR_PSP_REFERENCE", "resultCode" : "Authorised", - "merchantReference" : "string" + "merchantReference" : "YOUR_MERCHANT_REFERENCE" } }, "post-sessions-00.success" : { diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index fd75ebe..1dc3437 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v69/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v69/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=69) to find out what changed in this version!", - "x-timestamp" : "2023-02-09T12:22:12Z", + "x-timestamp" : "2023-02-22T11:25:50Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -270,7 +270,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -487,7 +487,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -777,7 +777,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -921,7 +921,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1644,6 +1644,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2158,6 +2160,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3284,7 +3288,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AcctInfo" : { "properties" : { @@ -3409,7 +3414,8 @@ "maxLength" : 3, "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3463,7 +3469,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3504,7 +3511,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3623,7 +3631,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3719,7 +3728,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3727,6 +3737,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3753,6 +3767,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3793,7 +3811,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3865,7 +3884,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -3937,7 +3957,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -4013,7 +4034,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -4021,7 +4043,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -4057,7 +4080,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -4073,7 +4097,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -4161,7 +4186,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4225,7 +4251,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4269,7 +4296,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4309,7 +4337,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4337,7 +4366,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4375,7 +4405,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4423,7 +4454,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4446,7 +4478,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4465,7 +4498,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4484,7 +4518,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4530,7 +4565,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4541,7 +4577,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4569,7 +4606,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationData" : { "properties" : { @@ -4583,17 +4621,12 @@ { "description" : "Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.", "value" : "never" - }, - { - "description" : "Do not perform 3D Secure authentication if not required by PSD2 SCA or other national regulations.", - "value" : "preferNo" } ], "description" : "Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).\n\nPossible values:\n\n* **always**: Perform 3D Secure authentication.\n* **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.\n* **preferNo**: Do not perform 3D Secure authentication if not required by PSD2 SCA or other national regulations.", "enum" : [ "always", - "never", - "preferNo" + "never" ], "type" : "string" }, @@ -4608,7 +4641,8 @@ "description" : "Object with additional parameters for the 3D Secure authentication flow.", "$ref" : "#/components/schemas/ThreeDSRequestData" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4625,7 +4659,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4671,7 +4706,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4713,7 +4749,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4742,7 +4779,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4776,7 +4814,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4838,7 +4877,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -4894,7 +4934,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -4906,7 +4947,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -5009,12 +5051,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -5045,7 +5083,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -5056,7 +5095,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -5079,7 +5119,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -5106,7 +5147,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5399,10 +5441,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5473,7 +5514,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5489,7 +5531,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5508,7 +5551,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5533,7 +5577,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5617,7 +5662,47 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5633,7 +5718,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5664,7 +5750,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5700,7 +5787,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5734,7 +5822,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5769,7 +5858,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSessionInstallmentOption" : { "properties" : { @@ -5797,7 +5887,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CheckoutThreeDS2Action" : { "additionalProperties" : false, @@ -5836,7 +5927,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5850,7 +5942,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5862,7 +5955,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -5953,7 +6047,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -5965,7 +6060,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -5993,7 +6089,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -6020,7 +6117,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -6041,7 +6139,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreateCheckoutSessionRequest" : { "properties" : { @@ -6354,7 +6453,8 @@ "reference", "returnUrl", "merchantAccount" - ] + ], + "type" : "object" }, "CreateCheckoutSessionResponse" : { "properties" : { @@ -6678,7 +6778,8 @@ "returnUrl", "expiresAt", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -6713,7 +6814,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -6728,7 +6830,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -6762,7 +6865,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -6778,6 +6882,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -6909,7 +7014,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -6977,7 +7082,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -7022,7 +7128,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -7037,7 +7144,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -7057,7 +7165,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -7086,7 +7195,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DetailsRequestAuthenticationData" : { "properties" : { @@ -7096,7 +7206,8 @@ "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.\nDefault: *false**.", "type" : "boolean" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -7124,7 +7235,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -7168,7 +7280,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -7205,7 +7318,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -7231,7 +7345,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -7264,7 +7379,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -7306,7 +7422,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -7322,7 +7439,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -7380,7 +7498,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -7403,7 +7522,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -7422,7 +7542,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "FundOrigin" : { "properties" : { @@ -7434,7 +7555,8 @@ "description" : "The name of the person", "$ref" : "#/components/schemas/Name" } - } + }, + "type" : "object" }, "FundRecipient" : { "properties" : { @@ -7478,7 +7600,8 @@ "description" : "indicates the tax identifier of the fund recepient", "type" : "string" } - } + }, + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -7519,7 +7642,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -7550,7 +7674,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -7595,7 +7720,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -7633,7 +7759,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -7686,7 +7813,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -7722,7 +7850,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -7743,7 +7872,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -7755,7 +7885,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -7767,7 +7898,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -7819,7 +7951,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -7868,7 +8001,8 @@ "format" : "int64", "type" : "integer" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -7928,7 +8062,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -7961,7 +8096,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -7992,7 +8128,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -8008,7 +8145,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -8094,7 +8232,8 @@ "description" : "Indicates shipping method chosen for the transaction.", "type" : "string" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -8113,7 +8252,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -8140,7 +8280,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -8156,7 +8297,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -8201,7 +8343,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -8251,7 +8394,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -8293,7 +8437,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -8338,7 +8483,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -8392,7 +8538,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -8425,7 +8572,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -8477,7 +8625,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -8556,7 +8705,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -8665,7 +8815,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -8781,7 +8932,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -9303,7 +9455,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -9319,6 +9472,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { + "deprecated" : true, "description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).", "$ref" : "#/components/schemas/ApplicationInfo" }, @@ -9456,7 +9610,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -9570,7 +9724,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -9630,7 +9785,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -9646,7 +9802,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodIssuer" : { "properties" : { @@ -9667,7 +9824,8 @@ "required" : [ "id", "name" - ] + ], + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -9792,7 +9950,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -9811,7 +9970,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -9874,7 +10034,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -10383,7 +10544,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -10394,6 +10556,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -10519,7 +10684,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -10552,7 +10718,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -10908,7 +11075,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -10924,7 +11092,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -10936,7 +11105,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -11029,7 +11199,8 @@ "required" : [ "merchantReference", "shopperLocale" - ] + ], + "type" : "object" }, "Phone" : { "properties" : { @@ -11044,12 +11215,13 @@ "maxLength" : 15, "type" : "string" } - } + }, + "type" : "object" }, "PlatformChargebackLogic" : { "properties" : { "behavior" : { - "x-addedInVersion" : "69", + "x-addedInVersion" : "68", "enum" : [ "deductAccordingToSplitRatio", "deductFromLiableAccount", @@ -11058,10 +11230,11 @@ "type" : "string" }, "targetAccount" : { - "x-addedInVersion" : "69", + "x-addedInVersion" : "68", "type" : "string" } - } + }, + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -11108,7 +11281,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -11145,7 +11319,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -11213,7 +11388,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -11237,7 +11413,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -11265,7 +11442,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -11301,7 +11479,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -11555,7 +11734,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -11607,7 +11787,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -11623,7 +11804,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -11631,7 +11813,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -11647,7 +11830,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "ResponsePaymentMethod" : { "properties" : { @@ -11660,7 +11844,8 @@ "type" : "string" } }, - "title" : "paymentResponse" + "title" : "paymentResponse", + "type" : "object" }, "RiskData" : { "properties" : { @@ -11687,7 +11872,8 @@ "description" : "The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -11707,7 +11893,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -11752,7 +11939,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -11796,7 +11984,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -11829,7 +12018,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -11845,7 +12035,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -11876,7 +12067,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -11892,7 +12084,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -11932,7 +12125,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -11950,7 +12144,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -11983,7 +12178,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -11999,7 +12195,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -12061,7 +12258,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -12106,7 +12304,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -12140,7 +12339,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "SubMerchant" : { "properties" : { @@ -12164,7 +12364,8 @@ "description" : "The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -12432,7 +12633,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2ResponseData" : { "properties" : { @@ -12493,7 +12695,8 @@ "transStatusReason" : { "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -12581,7 +12784,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestData" : { "properties" : { @@ -12661,7 +12865,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorAuthenticationInfo" : { "properties" : { @@ -12689,7 +12894,8 @@ "minLength" : 12, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorPriorAuthenticationInfo" : { "properties" : { @@ -12721,7 +12927,8 @@ "minLength" : 36, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -12807,7 +13014,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -12843,7 +13051,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -12890,7 +13099,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -12928,7 +13138,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -12966,7 +13177,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -12999,7 +13211,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -13019,7 +13232,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -13044,7 +13258,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -13080,7 +13295,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -13237,7 +13453,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -13323,7 +13539,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -13355,6 +13571,10 @@ "remainingAmount" : { "currency" : "EUR", "value" : 2500 + }, + "amount" : { + "currency" : "EUR", + "value" : 300 } } }, @@ -17794,7 +18014,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -17818,7 +18038,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -18024,7 +18250,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0", "paymentMethodType" : "giropay", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA", "method" : "GET", @@ -18080,7 +18305,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==", "paymentMethodType" : "ideal", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ", "method" : "GET", @@ -18109,7 +18333,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -18138,24 +18362,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -18173,7 +18397,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -18209,6 +18433,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", @@ -18244,7 +18469,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw==", "paymentMethodType" : "directEbanking", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA", "method" : "GET", diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index c36a226..b3edbf1 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Checkout API", "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v70/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v70/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=70) to find out what changed in this version!", - "x-timestamp" : "2023-02-09T12:22:12Z", + "x-timestamp" : "2023-02-22T11:25:50Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -274,7 +274,7 @@ "operationId" : "post-cardDetails", "x-groupName" : "Payments", "x-sortIndex" : 6, - "x-methodName" : "listBrandsOnCard", + "x-methodName" : "cardDetails", "security" : [ { "BasicAuth" : [ @@ -491,7 +491,7 @@ "operationId" : "post-orders", "x-groupName" : "Orders", "x-sortIndex" : 2, - "x-methodName" : "createOrder", + "x-methodName" : "orders", "security" : [ { "BasicAuth" : [ @@ -781,7 +781,7 @@ "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, - "x-methodName" : "createOriginkeyValuesForDomains", + "x-methodName" : "originKeys", "security" : [ { "BasicAuth" : [ @@ -925,7 +925,7 @@ "operationId" : "post-paymentLinks", "x-groupName" : "Payment links", "x-sortIndex" : 1, - "x-methodName" : "createPaymentLink", + "x-methodName" : "paymentLinks", "security" : [ { "BasicAuth" : [ @@ -1648,6 +1648,8 @@ ], "summary" : "Create a payment session", "description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-paymentSession", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 1, @@ -2162,6 +2164,8 @@ ], "summary" : "Verify a payment result", "description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "deprecated" : true, + "x-deprecatedInVersion" : "37", "operationId" : "post-payments-result", "x-groupName" : "Classic Checkout SDK", "x-sortIndex" : 2, @@ -3409,7 +3413,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AcctInfo" : { "properties" : { @@ -3534,7 +3539,8 @@ "maxLength" : 3, "type" : "string" } - } + }, + "type" : "object" }, "AchDetails" : { "additionalProperties" : false, @@ -3588,7 +3594,8 @@ "required" : [ "bankAccountNumber" ], - "title" : "ACH Direct Debit" + "title" : "ACH Direct Debit", + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -3629,7 +3636,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -3748,7 +3756,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -3844,7 +3853,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -3852,6 +3862,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -3878,6 +3892,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -3918,7 +3936,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -3990,7 +4009,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -4062,7 +4082,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -4138,7 +4159,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -4146,7 +4168,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -4182,7 +4205,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -4198,7 +4222,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -4286,7 +4311,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -4350,7 +4376,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -4394,7 +4421,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -4434,7 +4462,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -4462,7 +4491,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -4500,7 +4530,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AfterpayDetails" : { "additionalProperties" : false, @@ -4548,7 +4579,8 @@ "required" : [ "type" ], - "title" : "Afterpay" + "title" : "Afterpay", + "type" : "object" }, "AmazonPayDetails" : { "additionalProperties" : false, @@ -4571,7 +4603,8 @@ "type" : "string" } }, - "title" : "Amazon Pay" + "title" : "Amazon Pay", + "type" : "object" }, "Amount" : { "properties" : { @@ -4590,7 +4623,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "AndroidPayDetails" : { "additionalProperties" : false, @@ -4609,7 +4643,8 @@ "type" : "string" } }, - "title" : "Android Pay" + "title" : "Android Pay", + "type" : "object" }, "ApplePayDetails" : { "additionalProperties" : false, @@ -4655,7 +4690,8 @@ "required" : [ "applePayToken" ], - "title" : "Apple Pay" + "title" : "Apple Pay", + "type" : "object" }, "ApplePaySessionResponse" : { "properties" : { @@ -4666,7 +4702,8 @@ }, "required" : [ "data" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -4694,7 +4731,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationData" : { "properties" : { @@ -4708,17 +4746,12 @@ { "description" : "Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.", "value" : "never" - }, - { - "description" : "Do not perform 3D Secure authentication if not required by PSD2 SCA or other national regulations.", - "value" : "preferNo" } ], "description" : "Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).\n\nPossible values:\n\n* **always**: Perform 3D Secure authentication.\n* **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.\n* **preferNo**: Do not perform 3D Secure authentication if not required by PSD2 SCA or other national regulations.", "enum" : [ "always", - "never", - "preferNo" + "never" ], "type" : "string" }, @@ -4733,7 +4766,8 @@ "description" : "Object with additional parameters for the 3D Secure authentication flow.", "$ref" : "#/components/schemas/ThreeDSRequestData" } - } + }, + "type" : "object" }, "Avs" : { "properties" : { @@ -4750,7 +4784,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "BacsDirectDebitDetails" : { "additionalProperties" : false, @@ -4796,7 +4831,8 @@ "type" : "string" } }, - "title" : "BACS Direct Debit" + "title" : "BACS Direct Debit", + "type" : "object" }, "BankAccount" : { "properties" : { @@ -4838,7 +4874,8 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BillDeskDetails" : { "additionalProperties" : false, @@ -4867,7 +4904,8 @@ "type", "issuer" ], - "title" : "BillDesk" + "title" : "BillDesk", + "type" : "object" }, "BlikDetails" : { "additionalProperties" : false, @@ -4901,7 +4939,8 @@ "type" : "string" } }, - "title" : "BLIK" + "title" : "BLIK", + "type" : "object" }, "BrowserInfo" : { "properties" : { @@ -4963,7 +5002,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -5019,7 +5059,8 @@ "required" : [ "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CardBrandDetails" : { "properties" : { @@ -5031,7 +5072,8 @@ "description" : "The name of the card brand.", "type" : "string" } - } + }, + "type" : "object" }, "CardDetails" : { "additionalProperties" : false, @@ -5134,12 +5176,8 @@ "type" : "string" } }, - "required" : [ - "encryptedCardNumber", - "encryptedExpiryMonth", - "encryptedExpiryYear" - ], - "title" : "Card" + "title" : "Card", + "type" : "object" }, "CardDetailsRequest" : { "properties" : { @@ -5170,7 +5208,8 @@ "required" : [ "cardNumber", "merchantAccount" - ] + ], + "type" : "object" }, "CardDetailsResponse" : { "properties" : { @@ -5181,7 +5220,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CellulantDetails" : { "additionalProperties" : false, @@ -5204,7 +5244,8 @@ "type" : "string" } }, - "title" : "Cellulant" + "title" : "Cellulant", + "type" : "object" }, "CheckoutAwaitAction" : { "additionalProperties" : false, @@ -5231,7 +5272,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckRequest" : { "properties" : { @@ -5524,10 +5566,9 @@ }, "required" : [ "merchantAccount", - "reference", - "amount", "paymentMethod" - ] + ], + "type" : "object" }, "CheckoutBalanceCheckResponse" : { "properties" : { @@ -5598,7 +5639,8 @@ "required" : [ "balance", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCancelOrderRequest" : { "properties" : { @@ -5614,7 +5656,8 @@ "required" : [ "order", "merchantAccount" - ] + ], + "type" : "object" }, "CheckoutCancelOrderResponse" : { "properties" : { @@ -5633,7 +5676,8 @@ "required" : [ "pspReference", "resultCode" - ] + ], + "type" : "object" }, "CheckoutCreateOrderRequest" : { "properties" : { @@ -5658,7 +5702,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "CheckoutCreateOrderResponse" : { "properties" : { @@ -5742,7 +5787,47 @@ "expiresAt", "orderData", "resultCode" - ] + ], + "type" : "object" + }, + "CheckoutNativeRedirectAction" : { + "additionalProperties" : false, + "properties" : { + "data" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", + "type" : "object" + }, + "method" : { + "description" : "Specifies the HTTP method, for example GET or POST.", + "type" : "string" + }, + "nativeRedirectData" : { + "description" : "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", + "type" : "string" + }, + "paymentMethodType" : { + "description" : "Specifies the payment method.", + "type" : "string" + }, + "type" : { + "description" : "**nativeRedirect**", + "enum" : [ + "nativeRedirect" + ], + "type" : "string" + }, + "url" : { + "description" : "Specifies the URL to redirect to.", + "type" : "string" + } + }, + "required" : [ + "type" + ], + "type" : "object" }, "CheckoutOrder" : { "properties" : { @@ -5758,7 +5843,8 @@ "required" : [ "pspReference", "orderData" - ] + ], + "type" : "object" }, "CheckoutOrderResponse" : { "properties" : { @@ -5789,7 +5875,8 @@ }, "required" : [ "pspReference" - ] + ], + "type" : "object" }, "CheckoutQrCodeAction" : { "additionalProperties" : false, @@ -5825,7 +5912,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutRedirectAction" : { "additionalProperties" : false, @@ -5859,7 +5947,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSDKAction" : { "additionalProperties" : false, @@ -5894,7 +5983,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutSessionInstallmentOption" : { "properties" : { @@ -5922,7 +6012,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "CheckoutThreeDS2Action" : { "additionalProperties" : false, @@ -5961,7 +6052,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CheckoutUtilityRequest" : { "properties" : { @@ -5975,7 +6067,8 @@ }, "required" : [ "originDomains" - ] + ], + "type" : "object" }, "CheckoutUtilityResponse" : { "properties" : { @@ -5987,7 +6080,8 @@ "description" : "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.", "type" : "object" } - } + }, + "type" : "object" }, "CheckoutVoucherAction" : { "additionalProperties" : false, @@ -6078,7 +6172,8 @@ }, "required" : [ "type" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -6090,7 +6185,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "Company" : { "properties" : { @@ -6118,7 +6214,8 @@ "description" : "The company type.", "type" : "string" } - } + }, + "type" : "object" }, "Configuration" : { "properties" : { @@ -6145,7 +6242,8 @@ "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } - } + }, + "type" : "object" }, "CreateApplePaySessionRequest" : { "properties" : { @@ -6166,7 +6264,8 @@ "domainName", "merchantIdentifier", "displayName" - ] + ], + "type" : "object" }, "CreateCheckoutSessionRequest" : { "properties" : { @@ -6489,7 +6588,8 @@ "reference", "returnUrl", "merchantAccount" - ] + ], + "type" : "object" }, "CreateCheckoutSessionResponse" : { "properties" : { @@ -6833,7 +6933,8 @@ "returnUrl", "expiresAt", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentAmountUpdateRequest" : { "properties" : { @@ -6870,7 +6971,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentCancelRequest" : { "properties" : { @@ -6885,7 +6987,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentCaptureRequest" : { "properties" : { @@ -6919,7 +7022,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentLinkRequest" : { "properties" : { @@ -7062,7 +7166,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -7130,7 +7234,8 @@ "amount", "reference", "merchantAccount" - ] + ], + "type" : "object" }, "CreatePaymentRefundRequest" : { "properties" : { @@ -7175,7 +7280,8 @@ "required" : [ "merchantAccount", "amount" - ] + ], + "type" : "object" }, "CreatePaymentReversalRequest" : { "properties" : { @@ -7190,7 +7296,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "CreateStandalonePaymentCancelRequest" : { "properties" : { @@ -7210,7 +7317,8 @@ "required" : [ "merchantAccount", "paymentReference" - ] + ], + "type" : "object" }, "DetailsRequest" : { "properties" : { @@ -7239,7 +7347,8 @@ }, "required" : [ "details" - ] + ], + "type" : "object" }, "DetailsRequestAuthenticationData" : { "properties" : { @@ -7249,7 +7358,8 @@ "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.\nDefault: *false**.", "type" : "boolean" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -7277,7 +7387,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DokuDetails" : { "additionalProperties" : false, @@ -7321,7 +7432,8 @@ "lastName", "shopperEmail" ], - "title" : "Doku" + "title" : "Doku", + "type" : "object" }, "DonationResponse" : { "properties" : { @@ -7358,7 +7470,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "DotpayDetails" : { "additionalProperties" : false, @@ -7384,7 +7497,8 @@ "required" : [ "issuer" ], - "title" : "Dotpay" + "title" : "Dotpay", + "type" : "object" }, "DragonpayDetails" : { "additionalProperties" : false, @@ -7417,7 +7531,8 @@ "type", "issuer" ], - "title" : "Dragonpay" + "title" : "Dragonpay", + "type" : "object" }, "EcontextVoucherDetails" : { "additionalProperties" : false, @@ -7459,7 +7574,8 @@ "shopperEmail", "telephoneNumber" ], - "title" : "Voucher" + "title" : "Voucher", + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -7475,7 +7591,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -7533,7 +7650,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -7556,7 +7674,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -7575,7 +7694,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "FundOrigin" : { "properties" : { @@ -7587,7 +7707,8 @@ "description" : "The name of the person", "$ref" : "#/components/schemas/Name" } - } + }, + "type" : "object" }, "FundRecipient" : { "properties" : { @@ -7631,7 +7752,8 @@ "description" : "indicates the tax identifier of the fund recepient", "type" : "string" } - } + }, + "type" : "object" }, "GenericIssuerPaymentMethodDetails" : { "additionalProperties" : false, @@ -7672,7 +7794,8 @@ "type", "issuer" ], - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "GiropayDetails" : { "additionalProperties" : false, @@ -7703,7 +7826,8 @@ "type" : "string" } }, - "title" : "Giropay" + "title" : "Giropay", + "type" : "object" }, "GooglePayDetails" : { "additionalProperties" : false, @@ -7748,7 +7872,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "IdealDetails" : { "additionalProperties" : false, @@ -7786,7 +7911,8 @@ "required" : [ "issuer" ], - "title" : "iDEAL" + "title" : "iDEAL", + "type" : "object" }, "InputDetail" : { "properties" : { @@ -7839,7 +7965,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "InstallmentOption" : { "properties" : { @@ -7875,7 +8002,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -7896,7 +8024,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "InstallmentsNumber" : { "properties" : { @@ -7908,7 +8037,8 @@ }, "required" : [ "maxNumberOfInstallments" - ] + ], + "type" : "object" }, "Item" : { "properties" : { @@ -7920,7 +8050,8 @@ "description" : "The display name.", "type" : "string" } - } + }, + "type" : "object" }, "KlarnaDetails" : { "additionalProperties" : false, @@ -7972,7 +8103,8 @@ "required" : [ "type" ], - "title" : "Klarna" + "title" : "Klarna", + "type" : "object" }, "LineItem" : { "properties" : { @@ -8056,7 +8188,8 @@ "description" : "Universal Product Code.", "type" : "string" } - } + }, + "type" : "object" }, "ListStoredPaymentMethodsResponse" : { "properties" : { @@ -8075,7 +8208,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "Mandate" : { "properties" : { @@ -8135,7 +8269,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MasterpassDetails" : { "additionalProperties" : false, @@ -8168,7 +8303,8 @@ "required" : [ "masterpassTransactionId" ], - "title" : "Masterpass" + "title" : "Masterpass", + "type" : "object" }, "MbwayDetails" : { "additionalProperties" : false, @@ -8199,7 +8335,8 @@ "telephoneNumber", "shopperEmail" ], - "title" : "MBWay" + "title" : "MBWay", + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -8215,7 +8352,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -8301,7 +8439,8 @@ "description" : "Indicates shipping method chosen for the transaction.", "type" : "string" } - } + }, + "type" : "object" }, "MobilePayDetails" : { "additionalProperties" : false, @@ -8320,7 +8459,8 @@ "type" : "string" } }, - "title" : "MobilePay" + "title" : "MobilePay", + "type" : "object" }, "MolPayDetails" : { "additionalProperties" : false, @@ -8347,7 +8487,8 @@ "type", "issuer" ], - "title" : "MOLPay" + "title" : "MOLPay", + "type" : "object" }, "Name" : { "properties" : { @@ -8363,7 +8504,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "OpenInvoiceDetails" : { "additionalProperties" : false, @@ -8408,7 +8550,8 @@ "type" : "string" } }, - "title" : "Open Invoice" + "title" : "Open Invoice", + "type" : "object" }, "PayPalDetails" : { "additionalProperties" : false, @@ -8458,7 +8601,8 @@ "required" : [ "type" ], - "title" : "PayPal" + "title" : "PayPal", + "type" : "object" }, "PayUUpiDetails" : { "additionalProperties" : false, @@ -8500,7 +8644,8 @@ "required" : [ "type" ], - "title" : "PayU" + "title" : "PayU", + "type" : "object" }, "PayWithGoogleDetails" : { "additionalProperties" : false, @@ -8545,7 +8690,8 @@ "required" : [ "googlePayToken" ], - "title" : "Google Pay" + "title" : "Google Pay", + "type" : "object" }, "PaymentAmountUpdateResource" : { "properties" : { @@ -8601,7 +8747,8 @@ "reference", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCancelResource" : { "properties" : { @@ -8634,7 +8781,8 @@ "merchantAccount", "paymentPspReference", "pspReference" - ] + ], + "type" : "object" }, "PaymentCaptureResource" : { "properties" : { @@ -8686,7 +8834,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentCompletionDetails" : { "properties" : { @@ -8765,7 +8914,8 @@ "maxLength" : 100000, "type" : "string" } - } + }, + "type" : "object" }, "PaymentDetails" : { "additionalProperties" : false, @@ -8874,7 +9024,8 @@ "type" : "string" } }, - "title" : "Payment Details" + "title" : "Payment Details", + "type" : "object" }, "PaymentDetailsResponse" : { "properties" : { @@ -8990,7 +9141,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentDonationRequest" : { "properties" : { @@ -9522,7 +9674,8 @@ "returnUrl", "paymentMethod", "donationAccount" - ] + ], + "type" : "object" }, "PaymentLinkResponse" : { "properties" : { @@ -9671,7 +9824,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).", + "description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).", "type" : "string" }, "shopperName" : { @@ -9785,7 +9938,8 @@ "id", "url", "status" - ] + ], + "type" : "object" }, "PaymentMethod" : { "properties" : { @@ -9845,7 +9999,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodGroup" : { "properties" : { @@ -9861,7 +10016,8 @@ "description" : "The unique code of the group.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentMethodIssuer" : { "properties" : { @@ -9882,7 +10038,8 @@ "required" : [ "id", "name" - ] + ], + "type" : "object" }, "PaymentMethodsRequest" : { "properties" : { @@ -10007,7 +10164,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" }, "PaymentMethodsResponse" : { "properties" : { @@ -10026,7 +10184,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentRefundResource" : { "properties" : { @@ -10089,7 +10248,8 @@ "amount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -10608,7 +10768,8 @@ "amount", "returnUrl", "paymentMethod" - ] + ], + "type" : "object" }, "PaymentResponse" : { "properties" : { @@ -10619,6 +10780,9 @@ { "$ref" : "#/components/schemas/CheckoutAwaitAction" }, + { + "$ref" : "#/components/schemas/CheckoutNativeRedirectAction" + }, { "$ref" : "#/components/schemas/CheckoutQrCodeAction" }, @@ -10744,7 +10908,8 @@ "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } - } + }, + "type" : "object" }, "PaymentReversalResource" : { "properties" : { @@ -10777,7 +10942,8 @@ "merchantAccount", "pspReference", "paymentPspReference" - ] + ], + "type" : "object" }, "PaymentSetupRequest" : { "properties" : { @@ -11133,7 +11299,8 @@ "amount", "returnUrl", "countryCode" - ] + ], + "type" : "object" }, "PaymentSetupResponse" : { "properties" : { @@ -11149,7 +11316,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "PaymentVerificationRequest" : { "properties" : { @@ -11161,7 +11329,8 @@ }, "required" : [ "payload" - ] + ], + "type" : "object" }, "PaymentVerificationResponse" : { "properties" : { @@ -11254,7 +11423,8 @@ "required" : [ "merchantReference", "shopperLocale" - ] + ], + "type" : "object" }, "Phone" : { "properties" : { @@ -11269,12 +11439,13 @@ "maxLength" : 15, "type" : "string" } - } + }, + "type" : "object" }, "PlatformChargebackLogic" : { "properties" : { "behavior" : { - "x-addedInVersion" : "69", + "x-addedInVersion" : "68", "enum" : [ "deductAccordingToSplitRatio", "deductFromLiableAccount", @@ -11283,10 +11454,11 @@ "type" : "string" }, "targetAccount" : { - "x-addedInVersion" : "69", + "x-addedInVersion" : "68", "type" : "string" } - } + }, + "type" : "object" }, "RatepayDetails" : { "additionalProperties" : false, @@ -11333,7 +11505,8 @@ "required" : [ "type" ], - "title" : "Ratepay" + "title" : "Ratepay", + "type" : "object" }, "Recurring" : { "properties" : { @@ -11370,7 +11543,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RecurringDetail" : { "properties" : { @@ -11438,7 +11612,8 @@ "description" : "The unique payment method code.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -11462,7 +11637,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -11490,7 +11666,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -11526,7 +11703,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -11780,7 +11958,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -11832,7 +12011,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -11848,7 +12028,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -11856,7 +12037,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -11872,7 +12054,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "ResponsePaymentMethod" : { "properties" : { @@ -11885,7 +12068,8 @@ "type" : "string" } }, - "title" : "paymentResponse" + "title" : "paymentResponse", + "type" : "object" }, "RiskData" : { "properties" : { @@ -11912,7 +12096,8 @@ "description" : "The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -11932,7 +12117,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "SamsungPayDetails" : { "additionalProperties" : false, @@ -11977,7 +12163,8 @@ "required" : [ "samsungPayToken" ], - "title" : "Samsung Pay" + "title" : "Samsung Pay", + "type" : "object" }, "SepaDirectDebitDetails" : { "additionalProperties" : false, @@ -12021,7 +12208,8 @@ "iban", "ownerName" ], - "title" : "SEPA Direct Debit" + "title" : "SEPA Direct Debit", + "type" : "object" }, "ServiceError" : { "properties" : { @@ -12054,7 +12242,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ServiceError-2" : { "properties" : { @@ -12070,7 +12259,8 @@ "pspReference" : { "type" : "string" } - } + }, + "type" : "object" }, "ShopperInput" : { "properties" : { @@ -12101,7 +12291,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -12117,7 +12308,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -12157,7 +12349,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -12175,7 +12368,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "StandalonePaymentCancelResource" : { "properties" : { @@ -12208,7 +12402,8 @@ "merchantAccount", "pspReference", "paymentReference" - ] + ], + "type" : "object" }, "StoredDetails" : { "properties" : { @@ -12224,7 +12419,8 @@ "description" : "The email associated with stored payment details.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethod" : { "properties" : { @@ -12294,7 +12490,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "StoredPaymentMethodDetails" : { "additionalProperties" : false, @@ -12339,7 +12536,8 @@ "type" : "string" } }, - "title" : "Stored Payment Method" + "title" : "Stored Payment Method", + "type" : "object" }, "StoredPaymentMethodResource" : { "properties" : { @@ -12419,7 +12617,8 @@ "description" : "The type of payment method.", "type" : "string" } - } + }, + "type" : "object" }, "SubInputDetail" : { "properties" : { @@ -12453,7 +12652,8 @@ "description" : "The value can be pre-filled, if available.", "type" : "string" } - } + }, + "type" : "object" }, "SubMerchant" : { "properties" : { @@ -12477,7 +12677,8 @@ "description" : "The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -12745,7 +12946,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2ResponseData" : { "properties" : { @@ -12806,7 +13008,8 @@ "transStatusReason" : { "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -12894,7 +13097,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestData" : { "properties" : { @@ -12974,7 +13178,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorAuthenticationInfo" : { "properties" : { @@ -13002,7 +13207,8 @@ "minLength" : 12, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorPriorAuthenticationInfo" : { "properties" : { @@ -13034,7 +13240,8 @@ "minLength" : 36, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -13120,7 +13327,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "UpdatePaymentLinkRequest" : { "properties" : { @@ -13156,7 +13364,8 @@ }, "required" : [ "status" - ] + ], + "type" : "object" }, "UpiCollectDetails" : { "additionalProperties" : false, @@ -13203,7 +13412,8 @@ "type", "billingSequenceNumber" ], - "title" : "UPI Collect" + "title" : "UPI Collect", + "type" : "object" }, "UpiIntentDetails" : { "additionalProperties" : false, @@ -13241,7 +13451,8 @@ "required" : [ "type" ], - "title" : "UPI Intent" + "title" : "UPI Intent", + "type" : "object" }, "VippsDetails" : { "additionalProperties" : false, @@ -13279,7 +13490,8 @@ "required" : [ "telephoneNumber" ], - "title" : "Vipps" + "title" : "Vipps", + "type" : "object" }, "VisaCheckoutDetails" : { "additionalProperties" : false, @@ -13312,7 +13524,8 @@ "required" : [ "visaCheckoutCallId" ], - "title" : "Visa Checkout" + "title" : "Visa Checkout", + "type" : "object" }, "WeChatPayDetails" : { "additionalProperties" : false, @@ -13332,7 +13545,8 @@ "type" : "string" } }, - "title" : "WeChat Pay" + "title" : "WeChat Pay", + "type" : "object" }, "WeChatPayMiniProgramDetails" : { "additionalProperties" : false, @@ -13357,7 +13571,8 @@ "type" : "string" } }, - "title" : "WeChat Pay - Mini Program" + "title" : "WeChat Pay - Mini Program", + "type" : "object" }, "ZipDetails" : { "additionalProperties" : false, @@ -13393,7 +13608,8 @@ "type" : "string" } }, - "title" : "Zip" + "title" : "Zip", + "type" : "object" } }, "securitySchemes" : { @@ -13550,7 +13766,7 @@ }, { "type" : "cartebancaire", - "supported" : "true" + "supported" : true } ] } @@ -13636,7 +13852,7 @@ "reference" : "YOUR_DONATION_REFERENCE", "paymentMethod" : { "type" : "scheme", - "storedPaymentMethodId" : "8415718415172200" + "recurringDetailReference" : "7219687191761347" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", @@ -13668,6 +13884,10 @@ "remainingAmount" : { "currency" : "EUR", "value" : 2500 + }, + "amount" : { + "currency" : "EUR", + "value" : 300 } } }, @@ -18107,7 +18327,7 @@ "timeZoneOffset" : 0, "javaEnabled" : true }, - "channel" : "web", + "channel" : "Web", "origin" : "https://your-company.com", "returnUrl" : "https://your-company.com/checkout/", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -18131,7 +18351,13 @@ }, "browserInfo" : { "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0", - "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" + "acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "javaEnabled" : true, + "colorDepth" : 10, + "screenHeight" : 2000, + "screenWidth" : 3000, + "timeZoneOffset" : 5, + "language" : "en" }, "returnUrl" : "https://your-company.com/...", "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" @@ -18337,7 +18563,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0", "paymentMethodType" : "giropay", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA", "method" : "GET", @@ -18393,7 +18618,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==", "paymentMethodType" : "ideal", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ", "method" : "GET", @@ -18422,7 +18646,7 @@ }, "amount" : { "currency" : "SEK", - "value" : "1000" + "value" : 1000 }, "shopperLocale" : "en_US", "countryCode" : "SE", @@ -18451,24 +18675,24 @@ "returnUrl" : "https://www.your-company.com/...", "lineItems" : [ { - "quantity" : "1", - "amountExcludingTax" : "331", - "taxPercentage" : "2100", + "quantity" : 1, + "amountExcludingTax" : 331, + "taxPercentage" : 2100, "description" : "Shoes", "id" : "Item #1", - "taxAmount" : "69", - "amountIncludingTax" : "400", + "taxAmount" : 69, + "amountIncludingTax" : 400, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" }, { - "quantity" : "2", - "amountExcludingTax" : "248", - "taxPercentage" : "2100", + "quantity" : 2, + "amountExcludingTax" : 248, + "taxPercentage" : 2100, "description" : "Socks", "id" : "Item #2", - "taxAmount" : "52", - "amountIncludingTax" : "300", + "taxAmount" : 52, + "amountIncludingTax" : 300, "productUrl" : "URL_TO_PURCHASED_ITEM", "imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM" } @@ -18486,7 +18710,7 @@ "paymentMethod" : { "type" : "scheme", "storedPaymentMethodId" : "8416038790273850", - "cardDetails.cvc" : "737" + "cvc" : "737" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff", "returnUrl" : "https://your-company.com/...", @@ -18522,6 +18746,7 @@ }, "reference" : "Your order number", "paymentMethod" : { + "type" : "scheme", "storedPaymentMethodId" : "8316038796685850" }, "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription", @@ -18557,7 +18782,6 @@ "value" : { "resultCode" : "RedirectShopper", "action" : { - "paymentData" : "Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw==", "paymentMethodType" : "directEbanking", "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA", "method" : "GET", diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 5b30ea6..c9599dd 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v25/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v25/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:08Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -41,7 +41,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -172,7 +172,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -286,7 +286,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -400,7 +400,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -519,7 +519,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -638,7 +638,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -758,7 +758,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -909,7 +909,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1028,7 +1029,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1124,7 +1126,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1132,6 +1135,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1158,6 +1165,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -1198,7 +1209,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -1270,7 +1282,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -1342,7 +1355,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -1350,7 +1364,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -1426,7 +1441,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -1434,7 +1450,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -1470,7 +1487,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -1486,7 +1504,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -1574,7 +1593,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -1638,7 +1658,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -1682,7 +1703,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -1722,7 +1744,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -1750,7 +1773,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -1788,7 +1812,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -1807,7 +1832,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "BankAccount" : { "properties" : { @@ -1849,27 +1875,25 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, "required" : [ "userAgent", "acceptHeader" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -1956,7 +1980,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -2043,7 +2068,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -2135,7 +2161,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -2189,11 +2216,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -2251,7 +2277,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -2274,7 +2301,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -2293,7 +2321,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -2305,7 +2334,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -2365,7 +2395,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -2398,7 +2429,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -2414,7 +2446,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -2506,7 +2539,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -2673,7 +2706,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -2757,7 +2791,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -2909,7 +2943,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -3002,7 +3037,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -3028,7 +3064,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -3120,7 +3157,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -3144,7 +3182,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -3172,7 +3211,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -3208,7 +3248,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -3450,7 +3491,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -3502,7 +3544,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -3518,7 +3561,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -3526,7 +3570,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -3542,7 +3587,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -3567,7 +3613,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -3613,7 +3660,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -3703,7 +3751,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index c1a2979..6935012 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v30/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v30/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:08Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -290,7 +290,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -404,7 +404,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -518,7 +518,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -637,7 +637,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -756,7 +756,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -876,7 +876,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -996,7 +996,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1147,7 +1147,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1266,7 +1267,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1362,7 +1364,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1370,6 +1373,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1396,6 +1403,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -1436,7 +1447,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -1508,7 +1520,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -1580,7 +1593,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -1588,7 +1602,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -1664,7 +1679,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -1672,7 +1688,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -1708,7 +1725,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -1724,7 +1742,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -1812,7 +1831,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -1876,7 +1896,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -1920,7 +1941,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -1960,7 +1982,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -1988,7 +2011,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2026,7 +2050,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2123,7 +2148,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2142,7 +2168,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2184,27 +2211,25 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, "required" : [ "userAgent", "acceptHeader" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -2296,7 +2321,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -2388,7 +2414,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -2485,7 +2512,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -2539,11 +2567,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -2601,7 +2628,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -2624,7 +2652,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -2643,7 +2672,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -2655,7 +2685,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -2715,7 +2746,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -2748,7 +2780,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -2764,7 +2797,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -2856,7 +2890,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3033,7 +3067,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -3117,7 +3152,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3279,7 +3314,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -3372,7 +3408,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -3398,7 +3435,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -3495,7 +3533,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -3519,7 +3558,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -3547,7 +3587,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -3583,7 +3624,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -3825,7 +3867,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -3877,7 +3920,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -3893,7 +3937,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -3901,7 +3946,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -3917,7 +3963,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -3942,7 +3989,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -4034,7 +4082,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -4080,7 +4129,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -4175,7 +4225,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 6367e77..b79d17c 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v40/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v40/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:08Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -989,7 +989,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1109,7 +1109,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1344,7 +1344,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1578,7 +1578,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1613,7 +1614,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1732,7 +1734,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1828,7 +1831,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1836,6 +1840,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1862,6 +1870,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -1902,7 +1914,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -1974,7 +1987,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2046,7 +2060,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2054,7 +2069,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2130,7 +2146,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2138,7 +2155,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2174,7 +2192,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2190,7 +2209,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2278,7 +2298,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2342,7 +2363,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2386,7 +2408,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2426,7 +2449,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2454,7 +2478,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2492,7 +2517,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2597,7 +2623,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2616,7 +2643,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2644,7 +2672,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2686,14 +2715,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2738,8 +2766,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2752,7 +2778,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -2844,7 +2871,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -2944,7 +2972,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3049,7 +3078,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3103,11 +3133,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3119,7 +3148,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3147,7 +3177,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3176,7 +3207,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3192,7 +3224,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3250,7 +3283,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3273,7 +3307,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3292,7 +3327,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -3304,7 +3340,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3364,7 +3401,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3380,7 +3418,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3437,7 +3476,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3470,7 +3510,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3486,7 +3527,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3588,7 +3630,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3788,7 +3830,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -3882,7 +3925,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4067,7 +4110,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4161,7 +4205,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4346,7 +4390,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4439,7 +4484,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4476,7 +4522,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4581,7 +4628,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4605,7 +4653,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4633,7 +4682,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4669,7 +4719,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -4931,7 +4982,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -4983,7 +5035,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -4999,7 +5052,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5007,7 +5061,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5023,7 +5078,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5043,7 +5099,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5068,7 +5125,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5084,7 +5142,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5124,7 +5183,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5142,7 +5202,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5242,7 +5303,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5328,7 +5390,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5360,7 +5423,8 @@ "description" : "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5376,7 +5440,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5384,7 +5449,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5440,7 +5506,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5543,7 +5610,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index cc180ef..84a5df1 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v46/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v46/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:09Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -989,7 +989,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1109,7 +1109,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1344,7 +1344,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1578,7 +1578,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1613,7 +1614,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1732,7 +1734,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1828,7 +1831,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1836,6 +1840,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1862,6 +1870,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -1902,7 +1914,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -1974,7 +1987,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2046,7 +2060,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2054,7 +2069,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2130,7 +2146,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2138,7 +2155,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2174,7 +2192,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2190,7 +2209,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2278,7 +2298,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2342,7 +2363,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2386,7 +2408,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2426,7 +2449,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2454,7 +2478,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2492,7 +2517,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2602,7 +2628,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2621,7 +2648,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2649,7 +2677,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2691,14 +2720,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2743,8 +2771,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2757,7 +2783,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -2854,7 +2881,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -2959,7 +2987,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3069,7 +3098,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3123,11 +3153,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3139,7 +3168,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3167,7 +3197,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3196,7 +3227,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3212,7 +3244,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3270,7 +3303,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3293,7 +3327,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3312,7 +3347,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -3324,7 +3360,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3384,7 +3421,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3400,7 +3438,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3457,7 +3496,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3490,7 +3530,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3506,7 +3547,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3608,7 +3650,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3808,7 +3850,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -3902,7 +3945,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4087,7 +4130,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4181,7 +4225,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4366,7 +4410,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4459,7 +4504,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4496,7 +4542,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4606,7 +4653,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4630,7 +4678,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4658,7 +4707,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4694,7 +4744,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -4956,7 +5007,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5008,7 +5060,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5024,7 +5077,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5032,7 +5086,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5048,7 +5103,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5068,7 +5124,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5101,7 +5158,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5117,7 +5175,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5157,7 +5216,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5175,7 +5235,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5280,7 +5341,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5366,7 +5428,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5398,7 +5461,8 @@ "description" : "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5414,7 +5478,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5422,7 +5487,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5478,7 +5544,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5586,7 +5653,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 1824565..ce2a250 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v49/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v49/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:09Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -989,7 +989,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1109,7 +1109,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1344,7 +1344,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1578,7 +1578,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1613,7 +1614,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1732,7 +1734,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1828,7 +1831,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1836,6 +1840,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1862,6 +1870,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -1902,7 +1914,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -1974,7 +1987,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2046,7 +2060,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2054,7 +2069,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2130,7 +2146,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2138,7 +2155,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2174,7 +2192,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2190,7 +2209,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2278,7 +2298,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2342,7 +2363,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2386,7 +2408,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2426,7 +2449,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2454,7 +2478,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2492,7 +2517,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2602,7 +2628,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2621,7 +2648,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2649,7 +2677,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2691,14 +2720,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2743,8 +2771,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2757,7 +2783,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -2854,7 +2881,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -2959,7 +2987,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3069,7 +3098,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3123,11 +3153,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3139,7 +3168,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3167,7 +3197,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3196,7 +3227,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3212,7 +3244,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3270,7 +3303,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3293,7 +3327,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3312,7 +3347,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -3324,7 +3360,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3384,7 +3421,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3400,7 +3438,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3457,7 +3496,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3490,7 +3530,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3506,7 +3547,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3608,7 +3650,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3808,7 +3850,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -3902,7 +3945,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4087,7 +4130,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4181,7 +4225,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4366,7 +4410,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4459,7 +4504,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4496,7 +4542,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4606,7 +4653,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4630,7 +4678,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4658,7 +4707,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4694,7 +4744,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -4956,7 +5007,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5008,7 +5060,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5024,7 +5077,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5032,7 +5086,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5048,7 +5103,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5068,7 +5124,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5101,7 +5158,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5117,7 +5175,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5157,7 +5216,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5175,7 +5235,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5280,7 +5341,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5391,7 +5453,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5433,7 +5496,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5449,7 +5513,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5457,7 +5522,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5513,7 +5579,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5621,7 +5688,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 272f774..b066ec4 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v50/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v50/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:09Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -989,7 +989,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1109,7 +1109,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1344,7 +1344,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1588,7 +1588,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1623,7 +1624,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1742,7 +1744,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1838,7 +1841,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1846,6 +1850,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1872,6 +1880,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -1912,7 +1924,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -1984,7 +1997,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2056,7 +2070,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2064,7 +2079,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2140,7 +2156,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2148,7 +2165,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2184,7 +2202,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2200,7 +2219,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2288,7 +2308,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2352,7 +2373,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2396,7 +2418,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2436,7 +2459,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2464,7 +2488,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2502,7 +2527,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2612,7 +2638,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2631,7 +2658,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2659,7 +2687,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2701,14 +2730,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2753,8 +2781,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2767,7 +2793,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -2864,7 +2891,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -2969,7 +2997,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3079,7 +3108,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3133,11 +3163,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3149,7 +3178,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3177,7 +3207,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3206,7 +3237,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3222,7 +3254,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3280,7 +3313,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3303,7 +3337,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3322,7 +3357,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -3334,7 +3370,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3394,7 +3431,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3410,7 +3448,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3467,7 +3506,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3500,7 +3540,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3516,7 +3557,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3618,7 +3660,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3824,7 +3866,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -3918,7 +3961,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4109,7 +4152,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4203,7 +4247,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4394,7 +4438,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4487,7 +4532,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4524,7 +4570,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4634,7 +4681,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4658,7 +4706,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4686,7 +4735,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4722,7 +4772,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -4984,7 +5035,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5036,7 +5088,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5052,7 +5105,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5060,7 +5114,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5076,7 +5131,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5096,7 +5152,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5129,7 +5186,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5145,7 +5203,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5185,7 +5244,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5203,7 +5263,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5308,7 +5369,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5434,7 +5496,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5481,7 +5544,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5497,7 +5561,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5505,7 +5570,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5561,7 +5627,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5669,7 +5736,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index 521923d..069fc42 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v51/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v51/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:09Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -990,7 +990,7 @@ "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3dsAuthenticationResult", + "x-methodName" : "getAuthenticationResult", "security" : [ { "BasicAuth" : [ @@ -1104,7 +1104,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1339,7 +1339,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1459,7 +1459,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1703,7 +1703,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1738,7 +1739,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1857,7 +1859,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1953,7 +1956,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1961,6 +1965,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1987,6 +1995,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -2027,7 +2039,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -2099,7 +2112,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2171,7 +2185,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2179,7 +2194,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2255,7 +2271,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2263,7 +2280,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2299,7 +2317,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2315,7 +2334,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2403,7 +2423,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2467,7 +2488,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2511,7 +2533,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2551,7 +2574,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2579,7 +2603,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2617,7 +2642,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2727,7 +2753,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2746,7 +2773,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2774,7 +2802,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationResultRequest" : { "properties" : { @@ -2790,7 +2819,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "AuthenticationResultResponse" : { "properties" : { @@ -2802,7 +2832,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2844,14 +2875,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2896,8 +2926,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2910,7 +2938,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -3007,7 +3036,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -3112,7 +3142,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3222,7 +3253,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3276,11 +3308,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3292,7 +3323,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3320,7 +3352,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3349,7 +3382,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3365,7 +3399,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3423,7 +3458,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3446,7 +3482,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3465,7 +3502,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -3477,7 +3515,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3537,7 +3576,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3553,7 +3593,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3610,7 +3651,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3643,7 +3685,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3659,7 +3702,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3761,7 +3805,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3973,7 +4017,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -4067,7 +4112,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4264,7 +4309,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4358,7 +4404,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4555,7 +4601,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4648,7 +4695,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4685,7 +4733,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4795,7 +4844,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4819,7 +4869,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4847,7 +4898,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4883,7 +4935,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -5145,7 +5198,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5197,7 +5251,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5213,7 +5268,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5221,7 +5277,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5237,7 +5294,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5257,7 +5315,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5290,7 +5349,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5306,7 +5366,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5346,7 +5407,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5364,7 +5426,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5469,7 +5532,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS1Result" : { "properties" : { @@ -5497,7 +5561,8 @@ "description" : "A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5623,7 +5688,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5670,7 +5736,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5686,7 +5753,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5694,7 +5762,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5750,7 +5819,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5858,7 +5928,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index 920dae3..982cd2a 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v52/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v52/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:09Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -990,7 +990,7 @@ "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3dsAuthenticationResult", + "x-methodName" : "getAuthenticationResult", "security" : [ { "BasicAuth" : [ @@ -1104,7 +1104,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1339,7 +1339,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1459,7 +1459,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1703,7 +1703,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1738,7 +1739,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1857,7 +1859,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1953,7 +1956,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1961,6 +1965,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1987,6 +1995,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -2027,7 +2039,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -2099,7 +2112,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2171,7 +2185,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2179,7 +2194,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2255,7 +2271,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2263,7 +2280,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2299,7 +2317,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2315,7 +2334,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2403,7 +2423,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2467,7 +2488,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2511,7 +2533,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2551,7 +2574,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2579,7 +2603,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2617,7 +2642,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2727,7 +2753,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2746,7 +2773,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2774,7 +2802,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationResultRequest" : { "properties" : { @@ -2790,7 +2819,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "AuthenticationResultResponse" : { "properties" : { @@ -2802,7 +2832,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2844,14 +2875,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2896,8 +2926,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2910,7 +2938,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -3007,7 +3036,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -3112,7 +3142,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3222,7 +3253,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3276,11 +3308,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3292,7 +3323,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3320,7 +3352,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3349,7 +3382,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3365,7 +3399,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3423,7 +3458,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3446,7 +3482,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3465,7 +3502,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "Installments" : { "properties" : { @@ -3477,7 +3515,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3537,7 +3576,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3553,7 +3593,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3610,7 +3651,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3643,7 +3685,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3659,7 +3702,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3761,7 +3805,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -3981,7 +4025,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -4075,7 +4120,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4272,7 +4317,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4366,7 +4412,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4563,7 +4609,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4656,7 +4703,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4693,7 +4741,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4803,7 +4852,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4827,7 +4877,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4855,7 +4906,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4891,7 +4943,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -5153,7 +5206,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5205,7 +5259,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5221,7 +5276,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5229,7 +5285,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5245,7 +5302,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5265,7 +5323,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5298,7 +5357,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5314,7 +5374,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5354,7 +5415,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5372,7 +5434,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5477,7 +5540,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS1Result" : { "properties" : { @@ -5505,7 +5569,8 @@ "description" : "A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5631,7 +5696,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5678,7 +5744,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5694,7 +5761,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5702,7 +5770,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5758,7 +5827,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5866,7 +5936,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index ff44cb5..306396c 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v64/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v64/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:05Z", + "x-timestamp" : "2023-02-20T18:23:10Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -990,7 +990,7 @@ "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3dsAuthenticationResult", + "x-methodName" : "getAuthenticationResult", "security" : [ { "BasicAuth" : [ @@ -1104,7 +1104,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1339,7 +1339,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1459,7 +1459,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1703,7 +1703,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1738,7 +1739,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1857,7 +1859,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1953,7 +1956,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1961,6 +1965,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1987,6 +1995,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -2027,7 +2039,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -2099,7 +2112,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2171,7 +2185,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2179,7 +2194,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2255,7 +2271,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2263,7 +2280,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2299,7 +2317,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2315,7 +2334,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2403,7 +2423,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2467,7 +2488,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2511,7 +2533,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2551,7 +2574,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2579,7 +2603,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2617,7 +2642,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2727,7 +2753,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2746,7 +2773,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2774,7 +2802,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationResultRequest" : { "properties" : { @@ -2790,7 +2819,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "AuthenticationResultResponse" : { "properties" : { @@ -2802,7 +2832,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2844,14 +2875,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2896,8 +2926,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2910,7 +2938,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -3007,7 +3036,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -3112,7 +3142,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3222,7 +3253,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3276,11 +3308,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3292,7 +3323,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3320,7 +3352,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3349,7 +3382,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3365,7 +3399,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3423,7 +3458,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3446,7 +3482,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3465,7 +3502,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "FundDestination" : { "properties" : { @@ -3508,7 +3546,8 @@ "description" : "the telephone number of the person", "type" : "string" } - } + }, + "type" : "object" }, "FundSource" : { "properties" : { @@ -3539,7 +3578,8 @@ "description" : "Phone number of the person", "type" : "string" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -3560,7 +3600,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3620,7 +3661,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3636,7 +3678,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3693,7 +3736,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3726,7 +3770,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3742,7 +3787,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3844,7 +3890,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4074,7 +4120,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -4168,7 +4215,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4365,7 +4412,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4459,7 +4507,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4656,7 +4704,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4749,7 +4798,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4786,7 +4836,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4896,7 +4947,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4920,7 +4972,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4948,7 +5001,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4984,7 +5038,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -5246,7 +5301,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5298,7 +5354,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5314,7 +5371,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5322,7 +5380,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5338,7 +5397,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5358,7 +5418,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5391,7 +5452,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5407,7 +5469,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5447,7 +5510,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5465,7 +5529,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "SubMerchant" : { "properties" : { @@ -5489,7 +5554,8 @@ "description" : "The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5594,7 +5660,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS1Result" : { "properties" : { @@ -5622,7 +5689,8 @@ "description" : "A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5748,7 +5816,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5795,7 +5864,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5811,7 +5881,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5819,7 +5890,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5875,7 +5947,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -5983,7 +6056,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index c9946e4..e6e79f4 100644 --- a/json/PaymentService-v67.json +++ b/json/PaymentService-v67.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v67/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v67/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:06Z", + "x-timestamp" : "2023-02-20T18:23:10Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -990,7 +990,7 @@ "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3dsAuthenticationResult", + "x-methodName" : "getAuthenticationResult", "security" : [ { "BasicAuth" : [ @@ -1104,7 +1104,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1339,7 +1339,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1459,7 +1459,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1703,7 +1703,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1738,7 +1739,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1857,7 +1859,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -1953,7 +1956,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -1961,6 +1965,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -1987,6 +1995,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -2027,7 +2039,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -2099,7 +2112,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2171,7 +2185,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2179,7 +2194,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2255,7 +2271,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2263,7 +2280,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2299,7 +2317,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2315,7 +2334,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2403,7 +2423,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2467,7 +2488,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2511,7 +2533,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2551,7 +2574,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2579,7 +2603,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2617,7 +2642,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2727,7 +2753,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2746,7 +2773,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2774,7 +2802,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationResultRequest" : { "properties" : { @@ -2790,7 +2819,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "AuthenticationResultResponse" : { "properties" : { @@ -2802,7 +2832,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2844,14 +2875,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -2896,8 +2926,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -2910,7 +2938,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -3007,7 +3036,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -3112,7 +3142,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3222,7 +3253,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3276,11 +3308,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3292,7 +3323,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3320,7 +3352,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3349,7 +3382,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3365,7 +3399,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3423,7 +3458,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3446,7 +3482,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3465,7 +3502,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "FundDestination" : { "properties" : { @@ -3508,7 +3546,8 @@ "description" : "the telephone number of the person", "type" : "string" } - } + }, + "type" : "object" }, "FundSource" : { "properties" : { @@ -3539,7 +3578,8 @@ "description" : "Phone number of the person", "type" : "string" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -3560,7 +3600,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3620,7 +3661,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3636,7 +3678,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3693,7 +3736,8 @@ "description" : "Indicator for whether the shopper has already purchased the same items in the past.", "type" : "boolean" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3726,7 +3770,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3742,7 +3787,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -3844,7 +3890,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4068,7 +4114,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -4162,7 +4209,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4353,7 +4400,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4447,7 +4495,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4638,7 +4686,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4731,7 +4780,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4768,7 +4818,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -4878,7 +4929,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -4902,7 +4954,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -4930,7 +4983,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -4966,7 +5020,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -5220,7 +5275,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5272,7 +5328,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5288,7 +5345,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5296,7 +5354,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5312,7 +5371,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5332,7 +5392,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5365,7 +5426,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5381,7 +5443,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5421,7 +5484,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5439,7 +5503,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "SubMerchant" : { "properties" : { @@ -5463,7 +5528,8 @@ "description" : "The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5568,7 +5634,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS1Result" : { "properties" : { @@ -5596,7 +5663,8 @@ "description" : "A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -5722,7 +5790,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -5810,7 +5879,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -5826,7 +5896,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -5834,7 +5905,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -5914,7 +5986,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -6022,7 +6095,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index db604a2..177ad49 100644 --- a/json/PaymentService-v68.json +++ b/json/PaymentService-v68.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payment API", "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://pal-test.adyen.com/pal/servlet/Payment/v68/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-12-13T09:27:06Z", + "x-timestamp" : "2023-02-21T16:26:41Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -42,7 +42,7 @@ "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "changeTheAuthorisedAmount", + "x-methodName" : "adjustAuthorisation", "security" : [ { "BasicAuth" : [ @@ -161,7 +161,7 @@ "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, - "x-methodName" : "createAuthorisation", + "x-methodName" : "authorise", "security" : [ { "BasicAuth" : [ @@ -293,7 +293,7 @@ "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, - "x-methodName" : "complete3dsAuthorisation", + "x-methodName" : "authorise3d", "security" : [ { "BasicAuth" : [ @@ -408,7 +408,7 @@ "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, - "x-methodName" : "complete3ds2Authorisation", + "x-methodName" : "authorise3ds2", "security" : [ { "BasicAuth" : [ @@ -522,7 +522,7 @@ "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, - "x-methodName" : "cancelAuthorisation", + "x-methodName" : "cancel", "security" : [ { "BasicAuth" : [ @@ -636,7 +636,7 @@ "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, - "x-methodName" : "cancelOrRefundPayment", + "x-methodName" : "cancelOrRefund", "security" : [ { "BasicAuth" : [ @@ -755,7 +755,7 @@ "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, - "x-methodName" : "captureAuthorisation", + "x-methodName" : "capture", "security" : [ { "BasicAuth" : [ @@ -875,7 +875,7 @@ "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, - "x-methodName" : "createDonation", + "x-methodName" : "donate", "security" : [ { "BasicAuth" : [ @@ -990,7 +990,7 @@ "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3dsAuthenticationResult", + "x-methodName" : "getAuthenticationResult", "security" : [ { "BasicAuth" : [ @@ -1104,7 +1104,7 @@ "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, - "x-methodName" : "refundCapturedPayment", + "x-methodName" : "refund", "security" : [ { "BasicAuth" : [ @@ -1224,7 +1224,7 @@ "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, - "x-methodName" : "getThe3ds2AuthenticationResult", + "x-methodName" : "retrieve3ds2Result", "security" : [ { "BasicAuth" : [ @@ -1339,7 +1339,7 @@ "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, - "x-methodName" : "cancelAuthorisationUsingYourReference", + "x-methodName" : "technicalCancel", "security" : [ { "BasicAuth" : [ @@ -1459,7 +1459,7 @@ "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, - "x-methodName" : "cancelInpersonRefund", + "x-methodName" : "voidPendingRefund", "security" : [ { "BasicAuth" : [ @@ -1712,7 +1712,8 @@ "description" : "Shopper's work phone number (including the country code).", "type" : "string" } - } + }, + "type" : "object" }, "AcctInfo" : { "properties" : { @@ -1837,7 +1838,8 @@ "maxLength" : 3, "type" : "string" } - } + }, + "type" : "object" }, "AdditionalData3DSecure" : { "properties" : { @@ -1872,7 +1874,8 @@ "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataAirline" : { "properties" : { @@ -1991,7 +1994,8 @@ }, "required" : [ "airline.passenger_name" - ] + ], + "type" : "object" }, "AdditionalDataCarRental" : { "properties" : { @@ -2087,7 +2091,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataCommon" : { "properties" : { @@ -2095,6 +2100,10 @@ "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", "type" : "string" }, + "allowPartialAuth" : { + "description" : "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.", + "type" : "string" + }, "authorisationType" : { "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", "type" : "string" @@ -2121,6 +2130,10 @@ ], "type" : "string" }, + "manualCapture" : { + "description" : "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.", + "type" : "string" + }, "networkTxReference" : { "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", "type" : "string" @@ -2161,7 +2174,8 @@ "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLevel23" : { "properties" : { @@ -2233,7 +2247,8 @@ "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataLodging" : { "properties" : { @@ -2305,7 +2320,8 @@ "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataModifications" : { "properties" : { @@ -2313,7 +2329,8 @@ "description" : "This is the installment option selected by the shopper. It is required only if specified by the user.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpenInvoice" : { "properties" : { @@ -2389,7 +2406,8 @@ "description" : "URI where the customer can track their shipment.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataOpi" : { "properties" : { @@ -2397,7 +2415,8 @@ "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRatepay" : { "properties" : { @@ -2433,7 +2452,8 @@ "description" : "Identification name or number for the invoice, defined by the merchant.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRetry" : { "properties" : { @@ -2449,7 +2469,8 @@ "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRisk" : { "properties" : { @@ -2537,7 +2558,8 @@ "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataRiskStandalone" : { "properties" : { @@ -2601,7 +2623,8 @@ "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataSubMerchant" : { "properties" : { @@ -2645,7 +2668,8 @@ "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataTemporaryServices" : { "properties" : { @@ -2685,7 +2709,8 @@ "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", "type" : "string" } - } + }, + "type" : "object" }, "AdditionalDataWallets" : { "properties" : { @@ -2713,7 +2738,8 @@ "description" : "The Visa Checkout Call ID retrieved from the SDK.", "type" : "string" } - } + }, + "type" : "object" }, "Address" : { "properties" : { @@ -2751,7 +2777,8 @@ "city", "postalCode", "country" - ] + ], + "type" : "object" }, "AdjustAuthorisationRequest" : { "properties" : { @@ -2834,6 +2861,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -2861,7 +2893,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Amount" : { "properties" : { @@ -2880,7 +2913,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ApplicationInfo" : { "properties" : { @@ -2908,7 +2942,8 @@ "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", "$ref" : "#/components/schemas/ShopperInteractionDevice" } - } + }, + "type" : "object" }, "AuthenticationResultRequest" : { "properties" : { @@ -2924,7 +2959,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "AuthenticationResultResponse" : { "properties" : { @@ -2936,7 +2972,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "BankAccount" : { "properties" : { @@ -2978,14 +3015,13 @@ "description" : "The bank account holder's tax ID.", "type" : "string" } - } + }, + "type" : "object" }, "BrowserInfo" : { "properties" : { "acceptHeader" : { "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" }, "colorDepth" : { @@ -3030,8 +3066,6 @@ }, "userAgent" : { "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, "type" : "string" } }, @@ -3044,7 +3078,8 @@ "screenWidth", "timeZoneOffset", "language" - ] + ], + "type" : "object" }, "CancelOrRefundRequest" : { "properties" : { @@ -3123,6 +3158,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -3141,7 +3181,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CancelRequest" : { "properties" : { @@ -3220,6 +3261,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -3246,7 +3292,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "CaptureRequest" : { "properties" : { @@ -3329,6 +3376,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -3356,7 +3408,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "Card" : { "properties" : { @@ -3410,11 +3463,10 @@ } }, "required" : [ - "number", - "expiryMonth", "expiryYear", "holderName" - ] + ], + "type" : "object" }, "CommonField" : { "properties" : { @@ -3426,7 +3478,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "DeviceRenderOptions" : { "properties" : { @@ -3454,7 +3507,8 @@ }, "type" : "array" } - } + }, + "type" : "object" }, "DonationRequest" : { "properties" : { @@ -3474,6 +3528,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -3483,7 +3542,8 @@ "merchantAccount", "donationAccount", "modificationAmount" - ] + ], + "type" : "object" }, "ExternalPlatform" : { "properties" : { @@ -3499,7 +3559,8 @@ "description" : "Version of the field. For example, Version of External Platform.", "type" : "string" } - } + }, + "type" : "object" }, "ForexQuote" : { "properties" : { @@ -3557,7 +3618,8 @@ "required" : [ "validTill", "basePoints" - ] + ], + "type" : "object" }, "FraudCheckResult" : { "properties" : { @@ -3580,7 +3642,8 @@ "checkId", "name", "accountScore" - ] + ], + "type" : "object" }, "FraudResult" : { "properties" : { @@ -3599,7 +3662,8 @@ }, "required" : [ "accountScore" - ] + ], + "type" : "object" }, "FundDestination" : { "properties" : { @@ -3642,7 +3706,8 @@ "description" : "the telephone number of the person", "type" : "string" } - } + }, + "type" : "object" }, "FundSource" : { "properties" : { @@ -3673,7 +3738,8 @@ "description" : "Phone number of the person", "type" : "string" } - } + }, + "type" : "object" }, "Installments" : { "properties" : { @@ -3694,7 +3760,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "Mandate" : { "properties" : { @@ -3754,7 +3821,8 @@ "frequency", "amount", "endsAt" - ] + ], + "type" : "object" }, "MerchantDevice" : { "properties" : { @@ -3770,7 +3838,8 @@ "description" : "Merchant device reference.", "type" : "string" } - } + }, + "type" : "object" }, "MerchantRiskIndicator" : { "properties" : { @@ -3856,7 +3925,8 @@ "description" : "Indicates shipping method chosen for the transaction.", "type" : "string" } - } + }, + "type" : "object" }, "ModificationResult" : { "properties" : { @@ -3889,7 +3959,8 @@ "required" : [ "response", "pspReference" - ] + ], + "type" : "object" }, "Name" : { "properties" : { @@ -3905,7 +3976,8 @@ "required" : [ "firstName", "lastName" - ] + ], + "type" : "object" }, "PaymentRequest" : { "properties" : { @@ -4007,7 +4079,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4067,6 +4139,14 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "localizedShopperStatement" : { + "x-addedInVersion" : "68", + "additionalProperties" : { + "type" : "string" + }, + "description" : "This field allows merchants to use dynamic shopper statement in local character sets.\nThe local shopper statement field can be supplied in markets where localized merchant descriptors are used. Currently, Adyen only supports this in the Japanese market\n.The available character sets at the moment are:\n* Processing in Japan: **ja-Kana**\nThe character set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special characters.\nMerchants should send the Katakana shopperStatement in full-width characters. \nAn example request would be:\n> {\n \"shopperStatement\" : \"ADYEN - SELLER-A\",\n \"localizedShopperStatement\" : {\n \"ja-Kana\" : \"ADYEN - セラーA\"\n }\n}\nWe recommend merchants to always supply the field localizedShopperStatement in addition to the field shopperStatement.It is issuer dependent whether the localized shopper statement field is supported.\nIn the case of non-domestic transactions (e.g. US-issued cards processed in JP) the field `shopperStatement` is used to modify the statement of the shopper.\nAdyen handles the complexity of ensuring the correct descriptors are assigned.", + "type" : "object" + }, "mandate" : { "description" : "The mandate details to initiate recurring transaction.", "$ref" : "#/components/schemas/Mandate" @@ -4112,6 +4192,11 @@ "description" : "When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "recurring" : { "description" : "The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).", "$ref" : "#/components/schemas/Recurring" @@ -4231,7 +4316,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentRequest3d" : { "properties" : { @@ -4325,7 +4411,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4358,6 +4444,14 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "localizedShopperStatement" : { + "x-addedInVersion" : "68", + "additionalProperties" : { + "type" : "string" + }, + "description" : "This field allows merchants to use dynamic shopper statement in local character sets.\nThe local shopper statement field can be supplied in markets where localized merchant descriptors are used. Currently, Adyen only supports this in the Japanese market\n.The available character sets at the moment are:\n* Processing in Japan: **ja-Kana**\nThe character set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special characters.\nMerchants should send the Katakana shopperStatement in full-width characters. \nAn example request would be:\n> {\n \"shopperStatement\" : \"ADYEN - SELLER-A\",\n \"localizedShopperStatement\" : {\n \"ja-Kana\" : \"ADYEN - セラーA\"\n }\n}\nWe recommend merchants to always supply the field localizedShopperStatement in addition to the field shopperStatement.It is issuer dependent whether the localized shopper statement field is supported.\nIn the case of non-domestic transactions (e.g. US-issued cards processed in JP) the field `shopperStatement` is used to modify the statement of the shopper.\nAdyen handles the complexity of ensuring the correct descriptors are assigned.", + "type" : "object" + }, "mcc" : { "x-addedInVersion" : "12", "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -4516,7 +4610,8 @@ "merchantAccount", "paResponse", "md" - ] + ], + "type" : "object" }, "PaymentRequest3ds2" : { "properties" : { @@ -4610,7 +4705,7 @@ "dateOfBirth" : { "x-addedInVersion" : "7", "description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD", - "format" : "date-time", + "format" : "date", "type" : "string" }, "dccQuote" : { @@ -4643,6 +4738,14 @@ "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, + "localizedShopperStatement" : { + "x-addedInVersion" : "68", + "additionalProperties" : { + "type" : "string" + }, + "description" : "This field allows merchants to use dynamic shopper statement in local character sets.\nThe local shopper statement field can be supplied in markets where localized merchant descriptors are used. Currently, Adyen only supports this in the Japanese market\n.The available character sets at the moment are:\n* Processing in Japan: **ja-Kana**\nThe character set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special characters.\nMerchants should send the Katakana shopperStatement in full-width characters. \nAn example request would be:\n> {\n \"shopperStatement\" : \"ADYEN - SELLER-A\",\n \"localizedShopperStatement\" : {\n \"ja-Kana\" : \"ADYEN - セラーA\"\n }\n}\nWe recommend merchants to always supply the field localizedShopperStatement in addition to the field shopperStatement.It is issuer dependent whether the localized shopper statement field is supported.\nIn the case of non-domestic transactions (e.g. US-issued cards processed in JP) the field `shopperStatement` is used to modify the statement of the shopper.\nAdyen handles the complexity of ensuring the correct descriptors are assigned.", + "type" : "object" + }, "mcc" : { "x-addedInVersion" : "12", "description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.", @@ -4801,7 +4904,8 @@ "merchantAccount", "reference", "amount" - ] + ], + "type" : "object" }, "PaymentResult" : { "properties" : { @@ -4894,7 +4998,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "Phone" : { "properties" : { @@ -4909,7 +5014,26 @@ "maxLength" : 15, "type" : "string" } - } + }, + "type" : "object" + }, + "PlatformChargebackLogic" : { + "properties" : { + "behavior" : { + "x-addedInVersion" : "68", + "enum" : [ + "deductAccordingToSplitRatio", + "deductFromLiableAccount", + "deductFromOneBalanceAccount" + ], + "type" : "string" + }, + "targetAccount" : { + "x-addedInVersion" : "68", + "type" : "string" + } + }, + "type" : "object" }, "Recurring" : { "properties" : { @@ -4946,7 +5070,8 @@ ], "type" : "string" } - } + }, + "type" : "object" }, "RefundRequest" : { "properties" : { @@ -5029,6 +5154,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -5056,7 +5186,8 @@ "merchantAccount", "modificationAmount", "originalReference" - ] + ], + "type" : "object" }, "ResponseAdditionalData3DSecure" : { "properties" : { @@ -5080,7 +5211,8 @@ "description" : "Indicates whether a card is enrolled for 3D Secure 2.", "type" : "boolean" } - } + }, + "type" : "object" }, "ResponseAdditionalDataBillingAddress" : { "properties" : { @@ -5108,7 +5240,8 @@ "description" : "The billing address street passed in the payment request.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCard" : { "properties" : { @@ -5144,7 +5277,8 @@ "description" : "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataCommon" : { "properties" : { @@ -5398,7 +5532,8 @@ "description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataInstallments" : { "properties" : { @@ -5450,7 +5585,8 @@ "description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataNetworkTokens" : { "properties" : { @@ -5466,7 +5602,8 @@ "description" : "The last four digits of a network token.", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataOpi" : { "properties" : { @@ -5474,7 +5611,8 @@ "description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type" : "string" } - } + }, + "type" : "object" }, "ResponseAdditionalDataSepa" : { "properties" : { @@ -5490,7 +5628,8 @@ "description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type" : "string" } - } + }, + "type" : "object" }, "SDKEphemPubKey" : { "properties" : { @@ -5510,7 +5649,8 @@ "description" : "The `y` value as received from the 3D Secure 2 SDK.", "type" : "string" } - } + }, + "type" : "object" }, "ServiceError" : { "properties" : { @@ -5543,7 +5683,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "ShopperInteractionDevice" : { "properties" : { @@ -5559,7 +5700,8 @@ "description" : "Version of the operating system on the shopper interaction device.", "type" : "string" } - } + }, + "type" : "object" }, "Split" : { "properties" : { @@ -5599,7 +5741,8 @@ "required" : [ "amount", "type" - ] + ], + "type" : "object" }, "SplitAmount" : { "properties" : { @@ -5617,7 +5760,8 @@ }, "required" : [ "value" - ] + ], + "type" : "object" }, "SubMerchant" : { "properties" : { @@ -5641,7 +5785,8 @@ "description" : "The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", "type" : "string" } - } + }, + "type" : "object" }, "TechnicalCancelRequest" : { "properties" : { @@ -5720,6 +5865,11 @@ "description" : "The original merchant reference to cancel.", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -5746,7 +5896,8 @@ "required" : [ "merchantAccount", "originalMerchantReference" - ] + ], + "type" : "object" }, "ThreeDS1Result" : { "properties" : { @@ -5774,7 +5925,8 @@ "description" : "A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2RequestData" : { "properties" : { @@ -6042,7 +6194,8 @@ }, "required" : [ "deviceChannel" - ] + ], + "type" : "object" }, "ThreeDS2Result" : { "properties" : { @@ -6130,7 +6283,8 @@ "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } - } + }, + "type" : "object" }, "ThreeDS2ResultRequest" : { "properties" : { @@ -6146,7 +6300,8 @@ "required" : [ "merchantAccount", "pspReference" - ] + ], + "type" : "object" }, "ThreeDS2ResultResponse" : { "properties" : { @@ -6154,7 +6309,8 @@ "description" : "The result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } - } + }, + "type" : "object" }, "ThreeDSRequestorAuthenticationInfo" : { "properties" : { @@ -6182,7 +6338,8 @@ "minLength" : 12, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSRequestorPriorAuthenticationInfo" : { "properties" : { @@ -6214,7 +6371,8 @@ "minLength" : 36, "type" : "string" } - } + }, + "type" : "object" }, "ThreeDSecureData" : { "properties" : { @@ -6300,7 +6458,8 @@ "format" : "byte", "type" : "string" } - } + }, + "type" : "object" }, "VoidPendingRefundRequest" : { "properties" : { @@ -6383,6 +6542,11 @@ "description" : "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n", "type" : "string" }, + "platformChargebackLogic" : { + "x-addedInVersion" : "68", + "description" : "Defines the behavior to be applied in case of a chargeback.", + "$ref" : "#/components/schemas/PlatformChargebackLogic" + }, "reference" : { "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" @@ -6408,7 +6572,8 @@ }, "required" : [ "merchantAccount" - ] + ], + "type" : "object" } }, "securitySchemes" : { diff --git a/json/StoredValueService-v46.json b/json/StoredValueService-v46.json index 4a5ad0f..bddd81d 100644 --- a/json/StoredValueService-v46.json +++ b/json/StoredValueService-v46.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Stored Value API", "description" : "A set of API endpoints to manage stored value products.", - "x-timestamp" : "2023-02-09T20:21:26Z", + "x-timestamp" : "2023-02-20T18:23:08Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -37,7 +37,7 @@ "operationId" : "post-changeStatus", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "changesStatusOfPaymentMethod", + "x-methodName" : "changeStatus", "security" : [ { "BasicAuth" : [ @@ -121,7 +121,7 @@ "operationId" : "post-checkBalance", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "checksBalance", + "x-methodName" : "checkBalance", "security" : [ { "BasicAuth" : [ @@ -205,7 +205,7 @@ "operationId" : "post-issue", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "issuesNewCard", + "x-methodName" : "issue", "security" : [ { "BasicAuth" : [ @@ -289,7 +289,7 @@ "operationId" : "post-load", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "loadsPaymentMethod", + "x-methodName" : "load", "security" : [ { "BasicAuth" : [ @@ -373,7 +373,7 @@ "operationId" : "post-mergeBalance", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "mergeBalanceOfTwoCards", + "x-methodName" : "mergeBalance", "security" : [ { "BasicAuth" : [ @@ -457,7 +457,7 @@ "operationId" : "post-voidTransaction", "x-groupName" : "General", "x-sortIndex" : 0, - "x-methodName" : "voidsTransaction", + "x-methodName" : "voidTransaction", "security" : [ { "BasicAuth" : [ @@ -551,7 +551,8 @@ "required" : [ "value", "currency" - ] + ], + "type" : "object" }, "ServiceError" : { "properties" : { @@ -584,7 +585,8 @@ "format" : "int32", "type" : "integer" } - } + }, + "type" : "object" }, "StoredValueBalanceCheckRequest" : { "properties" : { @@ -634,7 +636,8 @@ "merchantAccount", "reference", "paymentMethod" - ] + ], + "type" : "object" }, "StoredValueBalanceCheckResponse" : { "properties" : { @@ -664,7 +667,8 @@ "description" : "Raw refusal reason received from the third party, where available", "type" : "string" } - } + }, + "type" : "object" }, "StoredValueBalanceMergeRequest" : { "properties" : { @@ -722,7 +726,8 @@ "reference", "paymentMethod", "sourcePaymentMethod" - ] + ], + "type" : "object" }, "StoredValueBalanceMergeResponse" : { "properties" : { @@ -756,7 +761,8 @@ "description" : "Raw refusal reason received from the third party, where available", "type" : "string" } - } + }, + "type" : "object" }, "StoredValueIssueRequest" : { "properties" : { @@ -806,7 +812,8 @@ "merchantAccount", "reference", "paymentMethod" - ] + ], + "type" : "object" }, "StoredValueIssueResponse" : { "properties" : { @@ -847,7 +854,8 @@ "description" : "Raw refusal reason received from the third party, where available", "type" : "string" } - } + }, + "type" : "object" }, "StoredValueLoadRequest" : { "properties" : { @@ -906,7 +914,8 @@ "reference", "paymentMethod", "amount" - ] + ], + "type" : "object" }, "StoredValueLoadResponse" : { "properties" : { @@ -940,7 +949,8 @@ "description" : "Raw refusal reason received from the third party, where available", "type" : "string" } - } + }, + "type" : "object" }, "StoredValueStatusChangeRequest" : { "properties" : { @@ -999,7 +1009,8 @@ "reference", "paymentMethod", "status" - ] + ], + "type" : "object" }, "StoredValueStatusChangeResponse" : { "properties" : { @@ -1033,7 +1044,8 @@ "description" : "Raw refusal reason received from the third party, where available", "type" : "string" } - } + }, + "type" : "object" }, "StoredValueVoidRequest" : { "properties" : { @@ -1067,7 +1079,8 @@ "required" : [ "merchantAccount", "originalReference" - ] + ], + "type" : "object" }, "StoredValueVoidResponse" : { "properties" : { @@ -1097,7 +1110,8 @@ "description" : "Raw refusal reason received from the third party, where available", "type" : "string" } - } + }, + "type" : "object" } }, "securitySchemes" : { diff --git a/yaml/BalanceControlService-v1.yaml b/yaml/BalanceControlService-v1.yaml index 695e037..8b8d2e1 100644 --- a/yaml/BalanceControlService-v1.yaml +++ b/yaml/BalanceControlService-v1.yaml @@ -50,7 +50,7 @@ info: ``` ' - x-timestamp: '2022-11-24T10:17:10Z' + x-timestamp: '2023-02-20T18:23:08Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -89,7 +89,7 @@ paths: operationId: post-balanceTransfer x-groupName: General x-sortIndex: 0 - x-methodName: startBalanceTransfer + x-methodName: balanceTransfer security: - BasicAuth: [] - ApiKeyAuth: [] @@ -127,6 +127,7 @@ components: required: - value - currency + type: object BalanceTransferRequest: properties: amount: @@ -169,6 +170,7 @@ components: - fromMerchant - toMerchant - type + type: object BalanceTransferResponse: properties: amount: @@ -231,6 +233,7 @@ components: - pspReference - status - createdAt + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index c9bb1a0..fcd7fdd 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=37) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:12Z' + x-timestamp: '2023-02-20T18:22:12Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1401,6 +1403,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2058,6 +2062,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2119,6 +2124,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2400,6 +2406,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2563,6 +2570,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2582,6 +2590,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2622,6 +2637,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2723,6 +2742,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2883,6 +2903,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3006,6 +3027,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3097,6 +3119,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3108,6 +3131,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3136,6 +3160,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3169,6 +3194,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3247,6 +3273,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3306,6 +3333,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3383,6 +3411,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3440,6 +3469,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3461,6 +3491,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3501,6 +3532,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3528,6 +3560,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3543,6 +3576,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3557,6 +3591,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3567,6 +3602,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3595,6 +3631,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3603,6 +3640,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3629,6 +3667,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3646,6 +3685,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3660,6 +3700,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3708,6 +3749,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3726,6 +3768,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3742,6 +3785,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -3753,6 +3797,7 @@ components: required: - userAgent - acceptHeader + type: object Card: properties: cvc: @@ -3819,6 +3864,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -3827,6 +3873,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -3906,11 +3953,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -3945,6 +3989,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -3952,6 +3997,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -3965,6 +4011,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutBalanceCheckRequest: properties: additionalAmount: @@ -4280,9 +4327,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4336,6 +4382,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4348,6 +4395,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4363,6 +4411,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4383,6 +4432,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4442,6 +4492,7 @@ components: - expiresAt - orderData - resultCode + type: object CheckoutOrder: properties: orderData: @@ -4453,6 +4504,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4475,6 +4527,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4484,6 +4537,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4493,6 +4547,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CommonField: properties: name: @@ -4501,6 +4556,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -4521,6 +4577,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -4552,6 +4609,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -4580,6 +4638,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -4610,6 +4669,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -4621,6 +4681,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -4654,6 +4715,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4670,6 +4732,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -4806,7 +4869,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -4839,6 +4902,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -4881,6 +4945,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -4892,6 +4957,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -4908,6 +4974,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -4921,6 +4988,7 @@ components: type: string required: - details + type: object DokuDetails: additionalProperties: false properties: @@ -4952,6 +5020,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -4994,6 +5063,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5010,6 +5080,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5032,6 +5103,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5062,6 +5134,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5073,6 +5146,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5116,6 +5190,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5133,6 +5208,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5146,6 +5222,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5168,6 +5245,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5182,6 +5260,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5209,6 +5288,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5229,6 +5309,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5267,6 +5348,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5274,6 +5356,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5288,6 +5371,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5296,6 +5380,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5304,6 +5389,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5335,6 +5421,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -5372,6 +5459,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -5434,6 +5522,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -5456,6 +5545,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -5475,6 +5565,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -5486,6 +5577,7 @@ components: reference: description: Merchant device reference. type: string + type: object MobilePayDetails: additionalProperties: false properties: @@ -5496,6 +5588,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -5513,6 +5606,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -5524,6 +5618,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -5549,6 +5644,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -5577,6 +5673,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -5600,6 +5697,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -5627,6 +5725,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -5674,6 +5773,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -5700,6 +5800,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -5747,6 +5848,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -5812,6 +5914,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -5912,6 +6015,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -6032,6 +6136,7 @@ components: shopperLocale: description: The shopperLocale. type: string + type: object PaymentDonationRequest: properties: additionalData: @@ -6487,6 +6592,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -6503,6 +6609,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -6639,7 +6746,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -6724,6 +6831,7 @@ components: - merchantAccount - url - status + type: object PaymentMethod: properties: configuration: @@ -6757,6 +6865,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -6769,6 +6878,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -6782,6 +6892,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -6880,6 +6991,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -6898,6 +7010,7 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -6953,6 +7066,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: additionalData: @@ -7397,6 +7511,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: additionalData: @@ -7511,6 +7626,7 @@ components: - Refused - Success type: string + type: object PaymentReversalResource: properties: merchantAccount: @@ -7538,6 +7654,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -7935,6 +8052,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -7947,6 +8065,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -7956,6 +8075,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -8083,6 +8203,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -8109,6 +8230,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -8135,6 +8257,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: configuration: @@ -8174,6 +8297,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -8195,6 +8319,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -8216,6 +8341,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8247,6 +8373,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -8301,6 +8428,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -8729,6 +8857,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -8780,6 +8909,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -8793,6 +8923,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -8802,6 +8933,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -8830,12 +8962,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -8862,6 +8996,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -8886,6 +9021,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: errorCode: @@ -8904,6 +9040,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -8914,6 +9051,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -8964,6 +9102,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -8976,6 +9115,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -9023,6 +9163,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -9040,6 +9181,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -9066,6 +9208,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -9077,6 +9220,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -9105,6 +9249,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -9129,6 +9274,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -9176,6 +9322,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -9209,6 +9356,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -9238,6 +9386,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -9258,6 +9407,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -9277,6 +9427,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -9301,6 +9452,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -9312,6 +9464,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -9326,6 +9479,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -9345,6 +9499,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -9464,7 +9619,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -9528,7 +9683,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -11863,6 +12018,7 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: @@ -11991,7 +12147,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 1b9756e..da16881 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=40) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:14Z' + x-timestamp: '2023-02-20T18:22:14Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1427,6 +1429,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2196,6 +2200,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2240,6 +2245,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2301,6 +2307,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2582,6 +2589,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2745,6 +2753,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2764,6 +2773,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2804,6 +2820,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2905,6 +2925,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3065,6 +3086,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3188,6 +3210,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3279,6 +3302,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3290,6 +3314,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3318,6 +3343,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3351,6 +3377,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3429,6 +3456,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3488,6 +3516,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3565,6 +3594,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3622,6 +3652,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3643,6 +3674,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3683,6 +3715,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3710,6 +3743,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3725,6 +3759,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3739,6 +3774,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3749,6 +3785,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3777,6 +3814,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3785,6 +3823,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3811,6 +3850,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3828,6 +3868,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3842,6 +3883,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3890,6 +3932,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3908,6 +3951,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3924,6 +3968,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -3981,6 +4026,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4047,6 +4093,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4055,6 +4102,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4134,11 +4182,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4173,6 +4218,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4180,6 +4226,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4193,6 +4240,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4533,9 +4581,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4589,6 +4636,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4601,6 +4649,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4616,6 +4665,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4636,6 +4686,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4695,6 +4746,7 @@ components: - expiresAt - orderData - resultCode + type: object CheckoutOrder: properties: orderData: @@ -4706,6 +4758,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4728,6 +4781,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4737,6 +4791,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4746,6 +4801,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CommonField: properties: name: @@ -4754,6 +4810,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -4774,6 +4831,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -4805,6 +4863,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -4833,6 +4892,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -4863,6 +4923,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -4874,6 +4935,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -4907,6 +4969,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4923,6 +4986,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5059,7 +5123,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5092,6 +5156,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5134,6 +5199,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5145,6 +5211,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5161,6 +5228,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5180,6 +5248,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5221,6 +5290,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5252,6 +5322,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5294,6 +5365,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5310,6 +5382,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5332,6 +5405,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5362,6 +5436,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5373,6 +5448,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5416,6 +5492,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5433,6 +5510,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5446,6 +5524,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5468,6 +5547,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5482,6 +5562,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5509,6 +5590,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5529,6 +5611,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5567,6 +5650,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5574,6 +5658,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5588,6 +5673,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5596,6 +5682,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5604,6 +5691,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5635,6 +5723,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -5672,6 +5761,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -5734,6 +5824,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -5756,6 +5847,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -5775,6 +5867,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -5786,6 +5879,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -5863,6 +5957,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -5873,6 +5968,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -5890,6 +5986,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -5901,6 +5998,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -5926,6 +6024,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -5954,6 +6053,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -5977,6 +6077,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6004,6 +6105,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6051,6 +6153,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6077,6 +6180,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6124,6 +6228,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6189,6 +6294,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6289,6 +6395,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -6413,6 +6520,7 @@ components: shopperLocale: description: The shopperLocale. type: string + type: object PaymentDonationRequest: properties: accountInfo: @@ -6902,6 +7010,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -6918,6 +7027,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7054,7 +7164,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7139,6 +7249,7 @@ components: - merchantAccount - url - status + type: object PaymentMethod: properties: configuration: @@ -7172,6 +7283,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7184,6 +7296,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7197,6 +7310,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7295,6 +7409,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7313,6 +7428,7 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7368,6 +7484,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -7846,6 +7963,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: additionalData: @@ -7967,6 +8085,7 @@ components: - Refused - Success type: string + type: object PaymentReversalResource: properties: merchantAccount: @@ -7994,6 +8113,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8396,6 +8516,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8408,6 +8529,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8417,6 +8539,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -8525,6 +8648,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -8551,6 +8675,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -8588,6 +8713,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: configuration: @@ -8627,6 +8753,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -8648,6 +8775,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -8669,6 +8797,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8700,6 +8829,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -8754,6 +8884,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9198,6 +9329,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9249,6 +9381,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9262,6 +9395,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9271,6 +9405,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9299,12 +9434,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9319,6 +9456,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9345,6 +9483,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9369,6 +9508,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: errorCode: @@ -9387,6 +9527,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9397,6 +9538,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -9447,6 +9589,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -9459,6 +9602,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -9506,6 +9650,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -9523,6 +9668,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -9549,6 +9695,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -9560,6 +9707,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -9588,6 +9736,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -9612,6 +9761,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: authenticationOnly: @@ -9724,6 +9874,7 @@ components: type: string required: - deviceChannel + type: object ThreeDSecureData: properties: authenticationResponse: @@ -9780,6 +9931,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -9813,6 +9965,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -9842,6 +9995,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -9862,6 +10016,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -9881,6 +10036,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -9905,6 +10061,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -9916,6 +10073,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -9930,6 +10088,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -9949,6 +10108,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10068,7 +10228,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10132,7 +10292,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -12489,6 +12649,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: @@ -12523,6 +12689,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: @@ -12624,7 +12796,6 @@ components: encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12642,7 +12813,6 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12717,7 +12887,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -12741,22 +12911,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -12769,7 +12939,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12795,6 +12965,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme recurringDetailReference: '8315791039321763' shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 2089173..767ad18 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=41) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:14Z' + x-timestamp: '2023-02-20T18:22:15Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1437,6 +1439,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2206,6 +2210,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2250,6 +2255,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2311,6 +2317,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2592,6 +2599,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2755,6 +2763,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2774,6 +2783,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2814,6 +2830,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2915,6 +2935,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3075,6 +3096,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3198,6 +3220,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3289,6 +3312,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3300,6 +3324,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3328,6 +3353,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3361,6 +3387,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3439,6 +3466,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3498,6 +3526,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3575,6 +3604,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3632,6 +3662,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3653,6 +3684,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3693,6 +3725,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3720,6 +3753,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3735,6 +3769,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3749,6 +3784,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3759,6 +3795,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3787,6 +3824,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3795,6 +3833,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3821,6 +3860,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3838,6 +3878,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3852,6 +3893,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3900,6 +3942,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3918,6 +3961,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3934,6 +3978,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -3991,6 +4036,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4057,6 +4103,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4065,6 +4112,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4144,11 +4192,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4183,6 +4228,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4190,6 +4236,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4203,6 +4250,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4543,9 +4591,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4599,6 +4646,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4611,6 +4659,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4626,6 +4675,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4646,6 +4696,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4705,6 +4756,7 @@ components: - expiresAt - orderData - resultCode + type: object CheckoutOrder: properties: orderData: @@ -4716,6 +4768,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4738,6 +4791,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4747,6 +4801,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4756,6 +4811,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CommonField: properties: name: @@ -4764,6 +4820,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -4784,6 +4841,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -4815,6 +4873,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -4843,6 +4902,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -4873,6 +4933,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -4884,6 +4945,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -4917,6 +4979,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4933,6 +4996,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5069,7 +5133,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5102,6 +5166,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5144,6 +5209,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5155,6 +5221,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5171,6 +5238,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5190,6 +5258,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5231,6 +5300,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5262,6 +5332,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5304,6 +5375,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5320,6 +5392,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5342,6 +5415,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5372,6 +5446,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5383,6 +5458,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5426,6 +5502,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5443,6 +5520,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5456,6 +5534,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5478,6 +5557,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5492,6 +5572,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5519,6 +5600,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5539,6 +5621,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5577,6 +5660,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5584,6 +5668,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5598,6 +5683,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5606,6 +5692,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5614,6 +5701,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5645,6 +5733,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -5682,6 +5771,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -5744,6 +5834,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -5766,6 +5857,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -5785,6 +5877,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -5796,6 +5889,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -5873,6 +5967,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -5883,6 +5978,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -5900,6 +5996,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -5911,6 +6008,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -5936,6 +6034,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -5964,6 +6063,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -5987,6 +6087,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6014,6 +6115,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6061,6 +6163,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6087,6 +6190,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6134,6 +6238,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6199,6 +6304,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6299,6 +6405,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -6427,6 +6534,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -6916,6 +7024,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -6932,6 +7041,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7068,7 +7178,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7153,6 +7263,7 @@ components: - merchantAccount - url - status + type: object PaymentMethod: properties: configuration: @@ -7186,6 +7297,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7198,6 +7310,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7211,6 +7324,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7309,6 +7423,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7327,6 +7442,7 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7382,6 +7498,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -7860,6 +7977,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: additionalData: @@ -7985,6 +8103,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8012,6 +8131,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8414,6 +8534,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8426,6 +8547,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8435,6 +8557,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -8543,6 +8666,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -8569,6 +8693,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -8606,6 +8731,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: configuration: @@ -8645,6 +8771,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -8666,6 +8793,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -8687,6 +8815,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8718,6 +8847,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -8772,6 +8902,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9216,6 +9347,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9267,6 +9399,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9280,6 +9413,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9289,6 +9423,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9317,12 +9452,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9337,6 +9474,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9363,6 +9501,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9387,6 +9526,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: errorCode: @@ -9405,6 +9545,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9415,6 +9556,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -9465,6 +9607,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -9477,6 +9620,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -9524,6 +9668,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -9541,6 +9686,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -9567,6 +9713,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -9578,6 +9725,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -9606,6 +9754,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -9630,6 +9779,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: authenticationOnly: @@ -9742,6 +9892,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -9768,6 +9919,7 @@ components: description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -9824,6 +9976,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -9857,6 +10010,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -9886,6 +10040,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -9906,6 +10061,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -9925,6 +10081,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -9949,6 +10106,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -9960,6 +10118,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -9974,6 +10133,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -9993,6 +10153,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10112,7 +10273,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10176,7 +10337,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -12530,7 +12691,7 @@ components: holderName: John Smith cvc: '737' additionalData: - allow3DS2: true + allow3DS2: 'true' accountInfo: accountCreationDate: '2019-01-17T13:42:40+01:00' billingAddress: @@ -12551,7 +12712,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12587,6 +12748,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: @@ -12621,6 +12788,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: @@ -12734,7 +12907,6 @@ components: encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12752,7 +12924,6 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12839,7 +13010,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -12863,22 +13034,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -12891,7 +13062,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12917,6 +13088,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme recurringDetailReference: '8315791039321763' shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 31fbd93..ea95f8f 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=46) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:15Z' + x-timestamp: '2023-02-20T18:22:16Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1437,6 +1439,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2206,6 +2210,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2250,6 +2255,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2311,6 +2317,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2592,6 +2599,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2755,6 +2763,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2774,6 +2783,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2814,6 +2830,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2915,6 +2935,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3075,6 +3096,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3198,6 +3220,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3289,6 +3312,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3300,6 +3324,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3328,6 +3353,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3361,6 +3387,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3439,6 +3466,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3498,6 +3526,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3575,6 +3604,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3632,6 +3662,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3653,6 +3684,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3693,6 +3725,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3720,6 +3753,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3735,6 +3769,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3749,6 +3784,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3759,6 +3795,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3787,6 +3824,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3795,6 +3833,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3821,6 +3860,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3838,6 +3878,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3852,6 +3893,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3900,6 +3942,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3918,6 +3961,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3934,6 +3978,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -3991,6 +4036,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4057,6 +4103,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4065,6 +4112,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4144,11 +4192,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4183,6 +4228,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4190,6 +4236,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4203,6 +4250,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4543,9 +4591,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4599,6 +4646,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4611,6 +4659,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4626,6 +4675,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4646,6 +4696,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4705,6 +4756,7 @@ components: - expiresAt - orderData - resultCode + type: object CheckoutOrder: properties: orderData: @@ -4716,6 +4768,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4738,6 +4791,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4747,6 +4801,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4756,6 +4811,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CommonField: properties: name: @@ -4764,6 +4820,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -4784,6 +4841,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -4815,6 +4873,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -4843,6 +4902,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -4873,6 +4933,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -4884,6 +4945,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -4917,6 +4979,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -4933,6 +4996,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5069,7 +5133,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5102,6 +5166,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5144,6 +5209,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5155,6 +5221,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5171,6 +5238,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5190,6 +5258,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5231,6 +5300,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5262,6 +5332,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5304,6 +5375,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5320,6 +5392,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5342,6 +5415,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5372,6 +5446,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5383,6 +5458,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5426,6 +5502,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5443,6 +5520,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5456,6 +5534,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5478,6 +5557,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5492,6 +5572,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5519,6 +5600,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5539,6 +5621,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5577,6 +5660,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5584,6 +5668,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5598,6 +5683,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5606,6 +5692,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5614,6 +5701,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5645,6 +5733,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -5682,6 +5771,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -5744,6 +5834,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -5766,6 +5857,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -5785,6 +5877,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -5796,6 +5889,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -5873,6 +5967,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -5883,6 +5978,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -5900,6 +5996,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -5911,6 +6008,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -5936,6 +6034,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -5964,6 +6063,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -5987,6 +6087,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6014,6 +6115,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6061,6 +6163,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6087,6 +6190,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6134,6 +6238,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6199,6 +6304,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6299,6 +6405,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -6427,6 +6534,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -6916,6 +7024,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -6932,6 +7041,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7068,7 +7178,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7153,6 +7263,7 @@ components: - merchantAccount - url - status + type: object PaymentMethod: properties: configuration: @@ -7186,6 +7297,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7198,6 +7310,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7211,6 +7324,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7309,6 +7423,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7327,6 +7442,7 @@ components: items: $ref: '#/components/schemas/PaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7382,6 +7498,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -7860,6 +7977,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: additionalData: @@ -7985,6 +8103,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8012,6 +8131,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8414,6 +8534,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8426,6 +8547,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8435,6 +8557,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -8543,6 +8666,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -8569,6 +8693,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -8606,6 +8731,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: configuration: @@ -8645,6 +8771,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -8666,6 +8793,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -8687,6 +8815,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -8718,6 +8847,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -8772,6 +8902,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9216,6 +9347,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9267,6 +9399,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9280,6 +9413,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9289,6 +9423,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9317,12 +9452,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9337,6 +9474,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9363,6 +9501,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9387,6 +9526,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9413,6 +9553,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9423,6 +9564,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -9473,6 +9615,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -9485,6 +9628,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -9532,6 +9676,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -9549,6 +9694,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -9575,6 +9721,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -9586,6 +9733,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -9614,6 +9762,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -9638,6 +9787,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: authenticationOnly: @@ -9750,6 +9900,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -9776,6 +9927,7 @@ components: description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -9832,6 +9984,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -9865,6 +10018,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -9894,6 +10048,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -9914,6 +10069,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -9933,6 +10089,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -9957,6 +10114,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -9968,6 +10126,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -9982,6 +10141,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10001,6 +10161,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10120,7 +10281,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10184,7 +10345,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -12596,6 +12757,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: @@ -12630,6 +12797,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: @@ -12743,7 +12916,6 @@ components: encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12761,7 +12933,6 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12848,7 +13019,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -12872,22 +13043,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -12900,7 +13071,7 @@ components: paymentMethod: type: scheme recurringDetailReference: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -12926,6 +13097,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme recurringDetailReference: '8315791039321763' shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 31c9b4e..1a84041 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=49) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:15Z' + x-timestamp: '2023-02-20T18:22:16Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1437,6 +1439,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2206,6 +2210,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2258,6 +2263,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2319,6 +2325,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2600,6 +2607,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2763,6 +2771,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2782,6 +2791,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2822,6 +2838,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2923,6 +2943,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3083,6 +3104,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3206,6 +3228,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3297,6 +3320,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3308,6 +3332,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3336,6 +3361,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3369,6 +3395,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3447,6 +3474,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3506,6 +3534,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3583,6 +3612,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3640,6 +3670,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3661,6 +3692,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3701,6 +3733,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3736,6 +3769,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3751,6 +3785,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3765,6 +3800,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3775,6 +3811,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3811,6 +3848,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3819,6 +3857,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3845,6 +3884,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3862,6 +3902,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3884,6 +3925,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3932,6 +3974,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3950,6 +3993,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3974,6 +4018,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4031,6 +4076,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4097,6 +4143,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4105,6 +4152,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4192,11 +4240,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4231,6 +4276,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4238,6 +4284,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4251,6 +4298,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4271,6 +4319,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4611,9 +4660,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4667,6 +4715,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4679,6 +4728,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4694,6 +4744,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4714,6 +4765,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4773,6 +4825,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4784,6 +4871,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4806,6 +4894,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4829,6 +4918,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4858,6 +4948,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4884,6 +4975,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4907,6 +4999,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4930,6 +5023,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4939,6 +5033,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4948,6 +5043,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5018,6 +5114,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5026,6 +5123,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5046,6 +5144,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5077,6 +5176,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5105,6 +5205,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5135,6 +5236,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5146,6 +5248,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5179,6 +5282,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5195,6 +5299,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5331,7 +5436,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5364,6 +5469,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5406,6 +5512,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5417,6 +5524,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5433,6 +5541,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5452,6 +5561,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5493,6 +5603,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5524,6 +5635,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5566,6 +5678,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5582,6 +5695,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5604,6 +5718,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5634,6 +5749,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5645,6 +5761,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5688,6 +5805,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5705,6 +5823,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5718,6 +5837,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5748,6 +5868,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5770,6 +5891,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5805,6 +5927,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5833,6 +5956,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5871,6 +5995,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5878,6 +6003,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5892,6 +6018,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5900,6 +6027,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5908,6 +6036,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5947,6 +6076,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -5984,6 +6114,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6046,6 +6177,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6068,6 +6200,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6087,6 +6220,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6098,6 +6232,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6175,6 +6310,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6185,6 +6321,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6202,6 +6339,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6213,6 +6351,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6246,6 +6385,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6282,6 +6422,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6313,6 +6454,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6348,6 +6490,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6395,6 +6538,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6421,6 +6565,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6468,6 +6613,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6533,6 +6679,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6633,6 +6780,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6767,6 +6915,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7266,6 +7415,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7282,6 +7432,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7418,7 +7569,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7503,6 +7654,7 @@ components: - merchantAccount - url - status + type: object PaymentMethod: properties: brands: @@ -7542,6 +7694,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7554,6 +7707,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7567,6 +7721,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7665,6 +7820,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7689,6 +7845,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7744,6 +7901,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8232,6 +8390,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8239,6 +8398,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8379,6 +8539,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8406,6 +8567,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8818,6 +8980,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8830,6 +8993,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8839,6 +9003,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -8947,6 +9112,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -8981,6 +9147,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9018,6 +9185,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brands: @@ -9063,6 +9231,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9084,6 +9253,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9105,6 +9275,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9136,6 +9307,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9190,6 +9362,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9634,6 +9807,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9685,6 +9859,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9698,6 +9873,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9707,6 +9883,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9735,12 +9912,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9755,6 +9934,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9789,6 +9969,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9821,6 +10002,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9847,6 +10029,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9857,6 +10040,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -9907,6 +10091,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -9919,6 +10104,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -9966,6 +10152,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -9983,6 +10170,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10009,6 +10197,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10020,6 +10209,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10055,6 +10245,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10091,6 +10282,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10115,6 +10307,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10263,6 +10456,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10297,6 +10491,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10353,6 +10548,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10386,6 +10582,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10423,6 +10620,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10451,6 +10649,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10478,6 +10677,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10502,6 +10702,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10513,6 +10714,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10527,6 +10729,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10554,6 +10757,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10673,7 +10877,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10737,7 +10941,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13091,7 +13295,7 @@ components: holderName: John Smith cvc: '737' additionalData: - allow3DS2: true + allow3DS2: 'true' accountInfo: accountCreationDate: '2019-01-17T13:42:40+01:00' billingAddress: @@ -13113,7 +13317,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13150,6 +13354,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: @@ -13185,6 +13395,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: @@ -13301,7 +13517,6 @@ components: encryptedExpiryMonth: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedExpiryYear: adyenjs_0_1_18$MT6ppy0FAMVMLH... encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13319,7 +13534,6 @@ components: expiryYear: '2030' holderName: John Smith cvc: '737' - storeDetails: true shopperReference: YOUR_UNIQUE_SHOPPER_ID returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13419,7 +13633,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13443,22 +13657,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13471,7 +13685,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13497,6 +13711,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 5a25d1f..5c7991b 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=50) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:16Z' + x-timestamp: '2023-02-20T18:22:17Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1441,6 +1443,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2227,6 +2231,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2279,6 +2284,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2340,6 +2346,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2621,6 +2628,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2784,6 +2792,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2803,6 +2812,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2843,6 +2859,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2944,6 +2964,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3104,6 +3125,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3227,6 +3249,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3318,6 +3341,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3329,6 +3353,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3357,6 +3382,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3390,6 +3416,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3468,6 +3495,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3527,6 +3555,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3604,6 +3633,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3661,6 +3691,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3682,6 +3713,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3722,6 +3754,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3757,6 +3790,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3772,6 +3806,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3786,6 +3821,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3796,6 +3832,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3832,6 +3869,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3840,6 +3878,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3866,6 +3905,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3883,6 +3923,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3905,6 +3946,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3953,6 +3995,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3971,6 +4014,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3995,6 +4039,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4052,6 +4097,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4118,6 +4164,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4126,6 +4173,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4213,11 +4261,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4252,6 +4297,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4259,6 +4305,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4272,6 +4319,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4292,6 +4340,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4638,9 +4687,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4694,6 +4742,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4706,6 +4755,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4721,6 +4771,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4741,6 +4792,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4800,6 +4852,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4811,6 +4898,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4833,6 +4921,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4856,6 +4945,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4885,6 +4975,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4911,6 +5002,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4934,6 +5026,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4957,6 +5050,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4966,6 +5060,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4975,6 +5070,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5045,6 +5141,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5053,6 +5150,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5073,6 +5171,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5104,6 +5203,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5132,6 +5232,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5162,6 +5263,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5173,6 +5275,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5206,6 +5309,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5222,6 +5326,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5358,7 +5463,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5396,6 +5501,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5438,6 +5544,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5449,6 +5556,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5465,6 +5573,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5484,6 +5593,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5525,6 +5635,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5556,6 +5667,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5598,6 +5710,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5614,6 +5727,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5636,6 +5750,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5666,6 +5781,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5677,6 +5793,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5720,6 +5837,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5737,6 +5855,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5750,6 +5869,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5780,6 +5900,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5802,6 +5923,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5837,6 +5959,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5865,6 +5988,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5903,6 +6027,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5910,6 +6035,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5924,6 +6050,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5932,6 +6059,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5940,6 +6068,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5979,6 +6108,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6016,6 +6146,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6078,6 +6209,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6100,6 +6232,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6119,6 +6252,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6130,6 +6264,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6207,6 +6342,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6217,6 +6353,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6234,6 +6371,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6245,6 +6383,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6278,6 +6417,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6314,6 +6454,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6345,6 +6486,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6380,6 +6522,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6427,6 +6570,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6453,6 +6597,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6500,6 +6645,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6565,6 +6711,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6665,6 +6812,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6799,6 +6947,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7304,6 +7453,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7320,6 +7470,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7456,7 +7607,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7546,6 +7697,7 @@ components: - merchantAccount - url - status + type: object PaymentMethod: properties: brands: @@ -7585,6 +7737,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7597,6 +7750,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7610,6 +7764,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7708,6 +7863,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7732,6 +7888,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7787,6 +7944,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8281,6 +8439,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8288,6 +8447,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8428,6 +8588,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8455,6 +8616,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8873,6 +9035,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8885,6 +9048,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8894,6 +9058,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9002,6 +9167,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9036,6 +9202,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9073,6 +9240,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brands: @@ -9118,6 +9286,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9139,6 +9308,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9160,6 +9330,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9191,6 +9362,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9245,6 +9417,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9689,6 +9862,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9740,6 +9914,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9753,6 +9928,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9762,6 +9938,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9790,12 +9967,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9810,6 +9989,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9844,6 +10024,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9876,6 +10057,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9902,6 +10084,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9912,6 +10095,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -9962,6 +10146,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -9974,6 +10159,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10021,6 +10207,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10038,6 +10225,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10064,6 +10252,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10075,6 +10264,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10110,6 +10300,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10146,6 +10337,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10170,6 +10362,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10331,6 +10524,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10370,6 +10564,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10426,6 +10621,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10459,6 +10655,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10496,6 +10693,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10524,6 +10722,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10551,6 +10750,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10575,6 +10775,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10586,6 +10787,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10600,6 +10802,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10627,6 +10830,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10746,7 +10950,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10810,7 +11014,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13164,7 +13368,7 @@ components: holderName: John Smith cvc: '737' additionalData: - allow3DS2: true + allow3DS2: 'true' accountInfo: accountCreationDate: '2019-01-17T13:42:40+01:00' billingAddress: @@ -13186,7 +13390,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13223,6 +13427,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-direct-200: @@ -13258,6 +13468,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-securedfields-200: @@ -13496,7 +13712,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13520,22 +13736,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13548,7 +13764,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13576,6 +13792,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 7d28a05..0ea061a 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=51) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:16Z' + x-timestamp: '2023-02-20T18:22:17Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2221,6 +2225,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2273,6 +2278,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2334,6 +2340,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2615,6 +2622,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2778,6 +2786,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2797,6 +2806,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2837,6 +2853,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2938,6 +2958,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3098,6 +3119,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3221,6 +3243,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3312,6 +3335,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3323,6 +3347,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3351,6 +3376,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3384,6 +3410,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3462,6 +3489,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3521,6 +3549,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3598,6 +3627,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3655,6 +3685,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3676,6 +3707,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3716,6 +3748,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3751,6 +3784,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3766,6 +3800,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3780,6 +3815,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3790,6 +3826,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3826,6 +3863,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3834,6 +3872,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3860,6 +3899,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3877,6 +3917,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3899,6 +3940,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3947,6 +3989,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3965,6 +4008,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3989,6 +4033,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4046,6 +4091,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4112,6 +4158,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4120,6 +4167,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4207,11 +4255,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4246,6 +4291,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4253,6 +4299,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4266,6 +4313,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4286,6 +4334,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4638,9 +4687,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4694,6 +4742,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4706,6 +4755,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4721,6 +4771,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4741,6 +4792,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4800,6 +4852,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4811,6 +4898,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4833,6 +4921,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4856,6 +4945,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4885,6 +4975,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4911,6 +5002,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4934,6 +5026,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4957,6 +5050,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4966,6 +5060,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4975,6 +5070,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5045,6 +5141,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5053,6 +5150,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5073,6 +5171,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5104,6 +5203,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5132,6 +5232,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5162,6 +5263,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5173,6 +5275,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5206,6 +5309,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5222,6 +5326,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5358,7 +5463,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5396,6 +5501,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5438,6 +5544,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5449,6 +5556,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5465,6 +5573,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5484,6 +5593,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5525,6 +5635,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5556,6 +5667,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5598,6 +5710,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5614,6 +5727,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5636,6 +5750,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5666,6 +5781,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5677,6 +5793,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5720,6 +5837,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5737,6 +5855,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5750,6 +5869,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5780,6 +5900,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5802,6 +5923,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5837,6 +5959,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5865,6 +5988,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5903,6 +6027,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5910,6 +6035,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5924,6 +6050,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5932,6 +6059,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5940,6 +6068,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5979,6 +6108,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6016,6 +6146,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6078,6 +6209,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6100,6 +6232,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6119,6 +6252,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6130,6 +6264,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6207,6 +6342,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6217,6 +6353,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6234,6 +6371,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6245,6 +6383,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6278,6 +6417,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6314,6 +6454,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6345,6 +6486,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6380,6 +6522,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6427,6 +6570,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6453,6 +6597,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6500,6 +6645,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6565,6 +6711,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6665,6 +6812,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6799,6 +6947,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7310,6 +7459,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7326,6 +7476,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7467,7 +7618,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7558,6 +7709,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brands: @@ -7597,6 +7749,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7609,6 +7762,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7622,6 +7776,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7726,6 +7881,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7750,6 +7906,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7805,6 +7962,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8305,6 +8463,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8312,6 +8471,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8452,6 +8612,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8479,6 +8640,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8903,6 +9065,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8915,6 +9078,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8924,6 +9088,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9032,6 +9197,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9066,6 +9232,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9103,6 +9270,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brands: @@ -9148,6 +9316,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9169,6 +9338,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9190,6 +9360,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9221,6 +9392,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9275,6 +9447,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9719,6 +9892,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9770,6 +9944,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9783,6 +9958,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9792,6 +9968,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9820,12 +9997,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9840,6 +10019,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9874,6 +10054,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9906,6 +10087,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9932,6 +10114,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9942,6 +10125,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -9992,6 +10176,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10004,6 +10189,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10051,6 +10237,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10068,6 +10255,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10094,6 +10282,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10105,6 +10294,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10140,6 +10330,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10176,6 +10367,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10200,6 +10392,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10361,6 +10554,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10400,6 +10594,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10456,6 +10651,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10489,6 +10685,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10526,6 +10723,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10554,6 +10752,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10581,6 +10780,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10605,6 +10805,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10616,6 +10817,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10630,6 +10832,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10657,6 +10860,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10776,7 +10980,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10840,7 +11044,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13194,7 +13398,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13214,7 +13418,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13236,6 +13440,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13477,7 +13687,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13501,22 +13711,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13529,7 +13739,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13557,6 +13767,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index ac55f29..79eb931 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=52) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:16Z' + x-timestamp: '2023-02-20T18:22:18Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2221,6 +2225,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2273,6 +2278,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2334,6 +2340,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2615,6 +2622,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2778,6 +2786,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2797,6 +2806,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2837,6 +2853,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2938,6 +2958,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3098,6 +3119,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3221,6 +3243,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3312,6 +3335,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3323,6 +3347,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3351,6 +3376,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3384,6 +3410,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3462,6 +3489,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3521,6 +3549,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3598,6 +3627,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3655,6 +3685,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3676,6 +3707,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3716,6 +3748,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3751,6 +3784,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3766,6 +3800,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3780,6 +3815,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3790,6 +3826,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3826,6 +3863,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3834,6 +3872,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3860,6 +3899,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3877,6 +3917,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3899,6 +3940,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3947,6 +3989,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3965,6 +4008,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3989,6 +4033,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4046,6 +4091,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4112,6 +4158,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4120,6 +4167,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4207,11 +4255,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4246,6 +4291,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4253,6 +4299,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4266,6 +4313,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4286,6 +4334,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4638,9 +4687,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4694,6 +4742,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4706,6 +4755,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4721,6 +4771,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4741,6 +4792,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4800,6 +4852,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4811,6 +4898,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4833,6 +4921,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4856,6 +4945,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4885,6 +4975,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4911,6 +5002,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4934,6 +5026,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4957,6 +5050,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4966,6 +5060,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4975,6 +5070,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5045,6 +5141,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5053,6 +5150,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5073,6 +5171,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5104,6 +5203,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5132,6 +5232,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5162,6 +5263,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5173,6 +5275,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5206,6 +5309,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5222,6 +5326,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5358,7 +5463,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5396,6 +5501,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5438,6 +5544,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5449,6 +5556,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5465,6 +5573,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5484,6 +5593,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5525,6 +5635,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5556,6 +5667,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5598,6 +5710,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5614,6 +5727,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5636,6 +5750,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5666,6 +5781,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5677,6 +5793,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5720,6 +5837,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5737,6 +5855,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5750,6 +5869,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5780,6 +5900,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5802,6 +5923,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5837,6 +5959,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5865,6 +5988,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5903,6 +6027,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5910,6 +6035,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5924,6 +6050,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5932,6 +6059,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5940,6 +6068,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5979,6 +6108,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6016,6 +6146,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6078,6 +6209,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6100,6 +6232,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6119,6 +6252,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6130,6 +6264,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6207,6 +6342,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6217,6 +6353,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6234,6 +6371,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6245,6 +6383,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6278,6 +6417,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6314,6 +6454,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6345,6 +6486,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6380,6 +6522,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6427,6 +6570,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6453,6 +6597,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6500,6 +6645,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6565,6 +6711,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6665,6 +6812,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6803,6 +6951,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7314,6 +7463,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7330,6 +7480,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7471,7 +7622,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7562,6 +7713,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brands: @@ -7601,6 +7753,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7613,6 +7766,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7626,6 +7780,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7730,6 +7885,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7754,6 +7910,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7809,6 +7966,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8309,6 +8467,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8316,6 +8475,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8460,6 +8620,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8487,6 +8648,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8911,6 +9073,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8923,6 +9086,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8932,6 +9096,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9040,6 +9205,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9074,6 +9240,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9111,6 +9278,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brands: @@ -9156,6 +9324,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9177,6 +9346,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9198,6 +9368,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9229,6 +9400,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9283,6 +9455,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9727,6 +9900,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9778,6 +9952,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9791,6 +9966,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9800,6 +9976,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9828,12 +10005,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9848,6 +10027,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9882,6 +10062,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9914,6 +10095,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9940,6 +10122,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9950,6 +10133,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -10000,6 +10184,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10012,6 +10197,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10059,6 +10245,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10076,6 +10263,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10102,6 +10290,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10113,6 +10302,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10148,6 +10338,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10184,6 +10375,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10208,6 +10400,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10369,6 +10562,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10408,6 +10602,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10464,6 +10659,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10497,6 +10693,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10534,6 +10731,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10562,6 +10760,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10589,6 +10788,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10613,6 +10813,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10624,6 +10825,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10638,6 +10840,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10665,6 +10868,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10784,7 +10988,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10848,7 +11052,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13202,7 +13406,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13222,7 +13426,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13244,6 +13448,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13485,7 +13695,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13509,22 +13719,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13537,7 +13747,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13565,6 +13775,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index 000981e..dc7e4d7 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=53) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:17Z' + x-timestamp: '2023-02-20T18:22:18Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2221,6 +2225,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2273,6 +2278,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2334,6 +2340,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2615,6 +2622,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2778,6 +2786,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2797,6 +2806,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2837,6 +2853,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2938,6 +2958,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3098,6 +3119,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3221,6 +3243,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3312,6 +3335,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3323,6 +3347,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3351,6 +3376,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3384,6 +3410,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3462,6 +3489,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3521,6 +3549,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3598,6 +3627,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3655,6 +3685,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3676,6 +3707,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3716,6 +3748,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3751,6 +3784,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3766,6 +3800,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3780,6 +3815,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3790,6 +3826,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3826,6 +3863,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3834,6 +3872,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3860,6 +3899,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3877,6 +3917,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3899,6 +3940,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3947,6 +3989,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3965,6 +4008,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3989,6 +4033,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4046,6 +4091,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4112,6 +4158,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4120,6 +4167,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4207,11 +4255,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4246,6 +4291,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4253,6 +4299,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4266,6 +4313,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4286,6 +4334,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4638,9 +4687,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4694,6 +4742,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4706,6 +4755,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4721,6 +4771,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4741,6 +4792,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4800,6 +4852,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4811,6 +4898,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4833,6 +4921,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4856,6 +4945,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4885,6 +4975,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4911,6 +5002,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4934,6 +5026,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4957,6 +5050,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4966,6 +5060,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4975,6 +5070,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5045,6 +5141,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5053,6 +5150,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5073,6 +5171,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5104,6 +5203,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5132,6 +5232,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5162,6 +5263,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5173,6 +5275,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5206,6 +5309,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5222,6 +5326,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5358,7 +5463,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5396,6 +5501,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5438,6 +5544,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5449,6 +5556,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5465,6 +5573,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5484,6 +5593,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5525,6 +5635,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5556,6 +5667,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5598,6 +5710,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5614,6 +5727,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5636,6 +5750,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5666,6 +5781,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5677,6 +5793,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5720,6 +5837,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5737,6 +5855,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5750,6 +5869,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5780,6 +5900,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5802,6 +5923,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5837,6 +5959,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5865,6 +5988,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5903,6 +6027,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5910,6 +6035,7 @@ components: method. format: int32 type: integer + type: object Installments: properties: value: @@ -5924,6 +6050,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5932,6 +6059,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5940,6 +6068,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -5979,6 +6108,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6016,6 +6146,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6078,6 +6209,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6100,6 +6232,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6119,6 +6252,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6130,6 +6264,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6207,6 +6342,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6217,6 +6353,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6234,6 +6371,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6245,6 +6383,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6278,6 +6417,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6314,6 +6454,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6345,6 +6486,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6380,6 +6522,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6427,6 +6570,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6453,6 +6597,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6500,6 +6645,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6565,6 +6711,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6665,6 +6812,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6803,6 +6951,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7314,6 +7463,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7330,6 +7480,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7471,7 +7622,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7562,6 +7713,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brands: @@ -7607,6 +7759,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7619,6 +7772,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7632,6 +7786,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7742,6 +7897,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7766,6 +7922,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7821,6 +7978,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8321,6 +8479,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8328,6 +8487,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8472,6 +8632,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8499,6 +8660,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8923,6 +9085,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8935,6 +9098,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8944,6 +9108,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9052,6 +9217,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9086,6 +9252,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9123,6 +9290,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brands: @@ -9174,6 +9342,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9195,6 +9364,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9216,6 +9386,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9247,6 +9418,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9301,6 +9473,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9745,6 +9918,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9796,6 +9970,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9809,6 +9984,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9818,6 +9994,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9846,12 +10023,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9866,6 +10045,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9900,6 +10080,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9932,6 +10113,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9958,6 +10140,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9968,6 +10151,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -10018,6 +10202,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10030,6 +10215,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10077,6 +10263,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10094,6 +10281,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10120,6 +10308,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10131,6 +10320,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10166,6 +10356,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10202,6 +10393,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10226,6 +10418,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10387,6 +10580,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10426,6 +10620,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10482,6 +10677,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10515,6 +10711,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10552,6 +10749,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10580,6 +10778,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10607,6 +10806,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10631,6 +10831,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10642,6 +10843,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10656,6 +10858,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10683,6 +10886,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10802,7 +11006,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10866,7 +11070,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13220,7 +13424,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13240,7 +13444,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13262,6 +13466,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13503,7 +13713,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13527,22 +13737,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13555,7 +13765,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13583,6 +13793,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 128ae02..82facfd 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=64) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:17Z' + x-timestamp: '2023-02-20T18:22:18Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2221,6 +2225,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2273,6 +2278,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2334,6 +2340,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2615,6 +2622,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2778,6 +2786,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2797,6 +2806,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2837,6 +2853,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2938,6 +2958,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3098,6 +3119,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3221,6 +3243,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3312,6 +3335,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3323,6 +3347,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3351,6 +3376,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3384,6 +3410,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3462,6 +3489,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3521,6 +3549,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3598,6 +3627,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3655,6 +3685,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3676,6 +3707,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3716,6 +3748,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3751,6 +3784,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3766,6 +3800,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3780,6 +3815,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3790,6 +3826,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3826,6 +3863,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3834,6 +3872,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3860,6 +3899,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3877,6 +3917,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3899,6 +3940,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3947,6 +3989,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3965,6 +4008,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3989,6 +4033,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4046,6 +4091,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4112,6 +4158,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4120,6 +4167,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4207,11 +4255,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4246,6 +4291,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4253,6 +4299,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4266,6 +4313,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4286,6 +4334,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4638,9 +4687,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4694,6 +4742,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4706,6 +4755,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4721,6 +4771,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4741,6 +4792,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4800,6 +4852,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4811,6 +4898,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4833,6 +4921,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4856,6 +4945,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4885,6 +4975,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4911,6 +5002,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4934,6 +5026,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4957,6 +5050,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4966,6 +5060,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4975,6 +5070,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5045,6 +5141,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5053,6 +5150,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5073,6 +5171,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5104,6 +5203,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5132,6 +5232,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5162,6 +5263,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5173,6 +5275,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5206,6 +5309,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5222,6 +5326,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5358,7 +5463,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5396,6 +5501,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5438,6 +5544,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5449,6 +5556,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5465,6 +5573,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5484,6 +5593,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5525,6 +5635,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5556,6 +5667,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5598,6 +5710,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5614,6 +5727,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5636,6 +5750,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5666,6 +5781,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5677,6 +5793,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5720,6 +5837,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5737,6 +5855,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5750,6 +5869,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5780,6 +5900,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5802,6 +5923,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5837,6 +5959,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5865,6 +5988,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5903,6 +6027,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5942,6 +6067,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -5970,6 +6096,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5978,6 +6105,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -5986,6 +6114,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -6025,6 +6154,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6062,6 +6192,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6124,6 +6255,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6146,6 +6278,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6165,6 +6298,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6176,6 +6310,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6253,6 +6388,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6263,6 +6399,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6280,6 +6417,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6291,6 +6429,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6324,6 +6463,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6360,6 +6500,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6391,6 +6532,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6426,6 +6568,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6473,6 +6616,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6499,6 +6643,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6546,6 +6691,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6611,6 +6757,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6711,6 +6858,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6863,6 +7011,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7374,6 +7523,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7390,6 +7540,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7531,7 +7682,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7622,6 +7773,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brands: @@ -7667,6 +7819,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7679,6 +7832,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsGroup: properties: groupType: @@ -7692,6 +7846,7 @@ components: items: type: string type: array + type: object PaymentMethodsRequest: properties: additionalData: @@ -7806,6 +7961,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: groups: @@ -7830,6 +7986,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7885,6 +8042,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8385,6 +8543,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8392,6 +8551,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8550,6 +8710,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8577,6 +8738,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -9001,6 +9163,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -9013,6 +9176,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -9022,6 +9186,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9130,6 +9295,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9164,6 +9330,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9201,6 +9368,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brands: @@ -9252,6 +9420,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9273,6 +9442,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9294,6 +9464,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9325,6 +9496,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9379,6 +9551,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9823,6 +9996,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9874,6 +10048,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9887,6 +10062,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9896,6 +10072,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9924,12 +10101,14 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9944,6 +10123,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9978,6 +10158,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -10010,6 +10191,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -10036,6 +10218,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -10046,6 +10229,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -10096,6 +10280,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10108,6 +10293,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10155,6 +10341,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10172,6 +10359,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10198,6 +10386,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10209,6 +10398,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10244,6 +10434,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10280,6 +10471,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10304,6 +10496,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10465,6 +10658,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10504,6 +10698,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10560,6 +10755,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10593,6 +10789,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10630,6 +10827,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10658,6 +10856,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10685,6 +10884,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10709,6 +10909,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10720,6 +10921,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10734,6 +10936,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10761,6 +10964,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10880,7 +11084,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10944,7 +11148,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13298,7 +13502,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13318,7 +13522,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13340,6 +13544,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13581,7 +13791,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13605,22 +13815,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13633,7 +13843,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13661,6 +13871,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 3d0dae1..bba7ee4 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=65) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:17Z' + x-timestamp: '2023-02-20T18:22:18Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2221,6 +2225,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2273,6 +2278,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2334,6 +2340,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2615,6 +2622,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2778,6 +2786,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2797,6 +2806,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2837,6 +2853,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2938,6 +2958,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3098,6 +3119,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3221,6 +3243,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3312,6 +3335,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3323,6 +3347,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3351,6 +3376,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3384,6 +3410,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3462,6 +3489,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3521,6 +3549,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3598,6 +3627,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3655,6 +3685,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3676,6 +3707,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3716,6 +3748,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3751,6 +3784,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3766,6 +3800,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3780,6 +3815,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3790,6 +3826,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3826,6 +3863,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3834,6 +3872,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3860,6 +3899,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3877,6 +3917,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3911,6 +3952,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3959,6 +4001,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3977,6 +4020,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -4001,6 +4045,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4058,6 +4103,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4124,6 +4170,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4132,6 +4179,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4219,11 +4267,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4258,6 +4303,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4265,6 +4311,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4278,6 +4325,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4298,6 +4346,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4644,9 +4693,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4705,6 +4753,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4717,6 +4766,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4732,6 +4782,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4752,6 +4803,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4811,6 +4863,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4822,6 +4909,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4844,6 +4932,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4867,6 +4956,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4896,6 +4986,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4922,6 +5013,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4945,6 +5037,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4968,6 +5061,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4977,6 +5071,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4986,6 +5081,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5056,6 +5152,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5064,6 +5161,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5084,6 +5182,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5115,6 +5214,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5143,6 +5243,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5173,6 +5274,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5184,6 +5286,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5217,6 +5320,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5233,6 +5337,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5373,7 +5478,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5411,6 +5516,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5453,6 +5559,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5464,6 +5571,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5480,6 +5588,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5499,6 +5608,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5540,6 +5650,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5571,6 +5682,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5613,6 +5725,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5629,6 +5742,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5651,6 +5765,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5681,6 +5796,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5692,6 +5808,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5735,6 +5852,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5752,6 +5870,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5765,6 +5884,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5795,6 +5915,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5817,6 +5938,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5852,6 +5974,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5880,6 +6003,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5918,6 +6042,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5957,6 +6082,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -5985,6 +6111,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5993,6 +6120,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -6001,6 +6129,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -6040,6 +6169,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6077,6 +6207,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6139,6 +6270,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6161,6 +6293,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6180,6 +6313,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6191,6 +6325,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6268,6 +6403,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6278,6 +6414,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6295,6 +6432,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6306,6 +6444,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6339,6 +6478,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6375,6 +6515,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6406,6 +6547,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6441,6 +6583,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6488,6 +6631,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6514,6 +6658,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6561,6 +6706,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6626,6 +6772,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6726,6 +6873,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6878,6 +7026,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7383,6 +7532,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7399,6 +7549,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7544,7 +7695,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7635,6 +7786,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brand: @@ -7680,6 +7832,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7692,6 +7845,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsRequest: properties: additionalData: @@ -7800,6 +7954,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: paymentMethods: @@ -7814,6 +7969,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7869,6 +8025,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8363,6 +8520,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8370,6 +8528,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8528,6 +8687,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8555,6 +8715,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8973,6 +9134,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8985,6 +9147,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8994,6 +9157,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9102,6 +9266,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9136,6 +9301,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9173,6 +9339,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brand: @@ -9224,6 +9391,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9245,6 +9413,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9266,6 +9435,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9297,6 +9467,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9351,6 +9522,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9788,6 +9960,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9839,6 +10012,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9852,6 +10026,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9861,6 +10036,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9889,6 +10065,7 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: @@ -9913,6 +10090,7 @@ components: description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9927,6 +10105,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9961,6 +10140,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9993,6 +10173,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -10019,6 +10200,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -10029,6 +10211,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -10079,6 +10262,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10091,6 +10275,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10138,6 +10323,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10155,6 +10341,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10181,6 +10368,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10192,6 +10380,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10227,6 +10416,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10263,6 +10453,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10287,6 +10478,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10448,6 +10640,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10487,6 +10680,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10543,6 +10737,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10576,6 +10771,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10613,6 +10809,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10641,6 +10838,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10668,6 +10866,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10692,6 +10891,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10703,6 +10903,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10717,6 +10918,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10744,6 +10946,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10865,7 +11068,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10929,7 +11132,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13283,7 +13486,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13303,7 +13506,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13325,6 +13528,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13566,7 +13775,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13590,22 +13799,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13618,7 +13827,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13646,6 +13855,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 2e69e28..9b4a432 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=66) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:18Z' + x-timestamp: '2023-02-20T18:22:19Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -575,7 +575,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -664,7 +664,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1107,6 +1107,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2221,6 +2225,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2273,6 +2278,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2334,6 +2340,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2615,6 +2622,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2778,6 +2786,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2797,6 +2806,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2837,6 +2853,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2938,6 +2958,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3098,6 +3119,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3221,6 +3243,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3312,6 +3335,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3323,6 +3347,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3351,6 +3376,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3384,6 +3410,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3462,6 +3489,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3521,6 +3549,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3598,6 +3627,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3655,6 +3685,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3676,6 +3707,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3716,6 +3748,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3751,6 +3784,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3766,6 +3800,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3780,6 +3815,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3790,6 +3826,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3826,6 +3863,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3834,6 +3872,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3860,6 +3899,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3877,6 +3917,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3911,6 +3952,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3959,6 +4001,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3977,6 +4020,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -4001,6 +4045,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4058,6 +4103,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4124,6 +4170,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4132,6 +4179,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4219,11 +4267,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4258,6 +4303,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4265,6 +4311,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4278,6 +4325,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4298,6 +4346,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4644,9 +4693,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4705,6 +4753,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4717,6 +4766,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4732,6 +4782,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4752,6 +4803,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4811,6 +4863,41 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4822,6 +4909,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4844,6 +4932,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4867,6 +4956,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4896,6 +4986,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4922,6 +5013,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2ChallengeAction: additionalProperties: false properties: @@ -4945,6 +5037,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2FingerPrintAction: additionalProperties: false properties: @@ -4968,6 +5061,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4977,6 +5071,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4986,6 +5081,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5056,6 +5152,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5064,6 +5161,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5084,6 +5182,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5115,6 +5214,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5143,6 +5243,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5173,6 +5274,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5184,6 +5286,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5217,6 +5320,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5233,6 +5337,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5373,7 +5478,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5411,6 +5516,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5453,6 +5559,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5464,6 +5571,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5480,6 +5588,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5499,6 +5608,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5540,6 +5650,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5571,6 +5682,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5613,6 +5725,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5629,6 +5742,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5651,6 +5765,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5681,6 +5796,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5692,6 +5808,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5735,6 +5852,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5752,6 +5870,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5765,6 +5884,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5795,6 +5915,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5817,6 +5938,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5852,6 +5974,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5880,6 +6003,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5918,6 +6042,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5957,6 +6082,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -5985,6 +6111,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5993,6 +6120,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -6001,6 +6129,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -6040,6 +6169,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6077,6 +6207,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6139,6 +6270,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6161,6 +6293,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6180,6 +6313,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6191,6 +6325,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6268,6 +6403,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6278,6 +6414,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6295,6 +6432,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6306,6 +6444,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6339,6 +6478,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6375,6 +6515,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6406,6 +6547,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6441,6 +6583,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6488,6 +6631,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6514,6 +6658,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6561,6 +6706,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6626,6 +6772,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6726,6 +6873,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: action: @@ -6882,6 +7030,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentDonationRequest: properties: accountInfo: @@ -7387,6 +7536,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7403,6 +7553,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7548,7 +7699,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7639,6 +7790,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brand: @@ -7684,6 +7836,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7696,6 +7849,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsRequest: properties: additionalData: @@ -7804,6 +7958,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: paymentMethods: @@ -7818,6 +7973,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7873,6 +8029,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8367,6 +8524,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8374,6 +8532,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8536,6 +8695,7 @@ components: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object PaymentReversalResource: properties: merchantAccount: @@ -8563,6 +8723,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8981,6 +9142,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8993,6 +9155,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -9002,6 +9165,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9110,6 +9274,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9144,6 +9309,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9181,6 +9347,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brand: @@ -9232,6 +9399,7 @@ components: type: description: The unique payment method code. type: string + type: object Redirect: properties: data: @@ -9253,6 +9421,7 @@ components: description: The URL, to which you must redirect a shopper to complete a payment. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9274,6 +9443,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9305,6 +9475,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9359,6 +9530,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9796,6 +9968,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9847,6 +10020,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9860,6 +10034,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9869,6 +10044,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9897,6 +10073,7 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: @@ -9921,6 +10098,7 @@ components: description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9935,6 +10113,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9969,6 +10148,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -10001,6 +10181,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -10027,6 +10208,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -10037,6 +10219,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -10087,6 +10270,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10099,6 +10283,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10146,6 +10331,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10163,6 +10349,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10189,6 +10376,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10200,6 +10388,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10235,6 +10424,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10271,6 +10461,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10295,6 +10486,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10456,6 +10648,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -10495,6 +10688,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10551,6 +10745,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10584,6 +10779,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10621,6 +10817,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10649,6 +10846,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10676,6 +10874,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10700,6 +10899,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10711,6 +10911,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10725,6 +10926,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10752,6 +10954,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10873,7 +11076,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -10937,7 +11140,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13291,7 +13494,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13311,7 +13514,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13333,6 +13536,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13574,7 +13783,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13598,22 +13807,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13626,7 +13835,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13654,6 +13863,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index b621d6c..4521ded 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=67) to find out what changed in this version!' - x-timestamp: '2023-02-08T17:21:18Z' + x-timestamp: '2023-02-20T18:22:19Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -577,7 +577,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -666,7 +666,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1109,6 +1109,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1433,6 +1435,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2219,6 +2223,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AchDetails: additionalProperties: false properties: @@ -2271,6 +2276,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2332,6 +2338,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2613,6 +2620,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2776,6 +2784,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2795,6 +2804,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -2835,6 +2851,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2936,6 +2956,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3096,6 +3117,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3219,6 +3241,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3310,6 +3333,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3321,6 +3345,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3349,6 +3374,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3382,6 +3408,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3460,6 +3487,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3519,6 +3547,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3596,6 +3625,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3653,6 +3683,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3674,6 +3705,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3714,6 +3746,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3749,6 +3782,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3764,6 +3798,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3778,6 +3813,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -3788,6 +3824,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -3824,6 +3861,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -3832,6 +3870,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -3858,6 +3897,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -3875,6 +3915,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -3909,6 +3950,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -3957,6 +3999,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -3975,6 +4018,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -3999,6 +4043,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4056,6 +4101,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4122,6 +4168,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4130,6 +4177,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4217,11 +4265,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4256,6 +4301,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4263,6 +4309,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4276,6 +4323,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4296,6 +4344,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4642,9 +4691,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4703,6 +4751,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4715,6 +4764,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4730,6 +4780,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -4750,6 +4801,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -4809,6 +4861,37 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -4820,6 +4903,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -4842,6 +4926,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -4865,6 +4950,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -4890,6 +4976,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -4916,6 +5003,7 @@ components: type: string required: - type + type: object CheckoutThreeDS2Action: additionalProperties: false properties: @@ -4945,6 +5033,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -4954,6 +5043,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -4963,6 +5053,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5033,6 +5124,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5041,6 +5133,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5061,6 +5154,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5092,6 +5186,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5120,6 +5215,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -5150,6 +5246,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -5161,6 +5258,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -5194,6 +5292,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -5210,6 +5309,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -5369,7 +5469,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -5414,6 +5514,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -5456,6 +5557,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -5467,6 +5569,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -5483,6 +5586,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -5502,6 +5606,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -5543,6 +5648,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -5574,6 +5680,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -5616,6 +5723,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -5632,6 +5740,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -5654,6 +5763,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -5684,6 +5794,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -5695,6 +5806,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -5738,6 +5850,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -5755,6 +5868,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -5768,6 +5882,7 @@ components: type: array required: - accountScore + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -5798,6 +5913,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -5820,6 +5936,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -5855,6 +5972,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -5883,6 +6001,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -5921,6 +6040,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -5960,6 +6080,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -5988,6 +6109,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -5996,6 +6118,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -6004,6 +6127,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -6043,6 +6167,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -6080,6 +6205,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -6142,6 +6268,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -6164,6 +6291,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -6183,6 +6311,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -6194,6 +6323,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -6271,6 +6401,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object MobilePayDetails: additionalProperties: false properties: @@ -6281,6 +6412,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -6298,6 +6430,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -6309,6 +6442,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -6342,6 +6476,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -6378,6 +6513,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -6409,6 +6545,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -6444,6 +6581,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -6491,6 +6629,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -6517,6 +6656,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -6564,6 +6704,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -6629,6 +6770,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -6729,6 +6871,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -6848,6 +6991,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentDonationRequest: properties: accountInfo: @@ -7353,6 +7497,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -7369,6 +7514,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -7533,7 +7679,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -7631,6 +7777,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brand: @@ -7676,6 +7823,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -7688,6 +7836,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodsRequest: properties: additionalData: @@ -7796,6 +7945,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: paymentMethods: @@ -7810,6 +7960,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -7865,6 +8016,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -8359,6 +8511,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -8366,6 +8519,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -8496,6 +8650,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentReversalResource: properties: merchantAccount: @@ -8523,6 +8678,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -8941,6 +9097,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -8953,6 +9110,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -8962,6 +9120,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -9070,6 +9229,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object RatepayDetails: additionalProperties: false properties: @@ -9104,6 +9264,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -9141,6 +9302,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brand: @@ -9192,6 +9354,7 @@ components: type: description: The unique payment method code. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -9213,6 +9376,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -9244,6 +9408,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -9298,6 +9463,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -9735,6 +9901,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -9786,6 +9953,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -9799,6 +9967,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -9808,6 +9977,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -9836,6 +10006,7 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: @@ -9860,6 +10031,7 @@ components: description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string + type: object SDKEphemPubKey: properties: crv: @@ -9874,6 +10046,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -9908,6 +10081,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -9940,6 +10114,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -9966,6 +10141,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -9976,6 +10152,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -10026,6 +10203,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -10038,6 +10216,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -10085,6 +10264,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -10102,6 +10282,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -10128,6 +10309,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -10139,6 +10321,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -10182,6 +10365,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -10218,6 +10402,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -10242,6 +10427,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -10403,6 +10589,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2ResponseData: properties: acsChallengeMandated: @@ -10443,6 +10630,7 @@ components: type: string transStatusReason: type: string + type: object ThreeDS2Result: properties: authenticationValue: @@ -10545,6 +10733,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -10625,6 +10814,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -10658,6 +10848,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -10695,6 +10886,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -10723,6 +10915,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -10750,6 +10943,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -10774,6 +10968,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -10785,6 +10980,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -10799,6 +10995,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -10826,6 +11023,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -10947,7 +11145,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -11011,7 +11209,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13365,7 +13563,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -13385,7 +13583,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13407,6 +13605,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -13436,10 +13640,10 @@ components: cvcResultRaw: M refusalReasonRaw: AUTHORISED acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-card-securedfields: summary: Make a card payment (using encrypted card details) value: @@ -13466,10 +13670,10 @@ components: cvcResultRaw: M refusalReasonRaw: AUTHORISED acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIE9N - pspReference: 993617895215577D + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-details-3d-secure-2-native: summary: Submit 3D Secure 2 authentication result value: @@ -13513,10 +13717,10 @@ components: refusalReasonRaw: AUTHORISED recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VC172 - pspReference: 993617895195570C + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments value: @@ -13551,10 +13755,10 @@ components: refusalReasonRaw: AUTHORISED recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-giropay: summary: Make a giropay payment value: @@ -13571,7 +13775,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 paymentMethodType: giropay url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA method: GET @@ -13612,7 +13815,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== paymentMethodType: ideal url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ method: GET @@ -13633,7 +13835,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -13657,22 +13859,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -13685,7 +13887,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -13713,6 +13915,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... @@ -13739,7 +13942,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== paymentMethodType: directEbanking url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA method: GET @@ -13812,7 +14014,7 @@ components: refusalReasonRaw: AUTHORISED recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VD896 - pspReference: 993617895199574A + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index b7eed79..397a70c 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=68) to find out what changed in this version!' - x-timestamp: '2023-02-09T12:22:11Z' + x-timestamp: '2023-02-21T16:25:42Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -577,7 +577,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -666,7 +666,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1109,6 +1109,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1433,6 +1435,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2277,6 +2281,7 @@ components: x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. description: Shopper's work phone number (including the country code). type: string + type: object AcctInfo: properties: chAccAgeInd: @@ -2415,6 +2420,7 @@ components: in the previous year. Max length: 3 characters.' maxLength: 3 type: string + type: object AchDetails: additionalProperties: false properties: @@ -2471,6 +2477,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2532,6 +2539,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2813,6 +2821,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2976,6 +2985,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -2995,6 +3005,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -3035,6 +3052,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -3136,6 +3157,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3296,6 +3318,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3419,6 +3442,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3510,6 +3534,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3521,6 +3546,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3549,6 +3575,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3582,6 +3609,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3660,6 +3688,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3719,6 +3748,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3796,6 +3826,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3853,6 +3884,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3874,6 +3906,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3914,6 +3947,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3953,6 +3987,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3972,6 +4007,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3986,6 +4022,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -4000,6 +4037,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -4040,6 +4078,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -4048,6 +4087,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -4074,6 +4114,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object Avs: properties: addressEditable: @@ -4091,6 +4132,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -4129,6 +4171,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -4177,6 +4220,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -4199,6 +4243,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -4227,6 +4272,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4284,6 +4330,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4350,6 +4397,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4358,6 +4406,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4449,11 +4498,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4488,6 +4534,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4495,6 +4542,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4512,6 +4560,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4532,6 +4581,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4899,9 +4949,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -4960,6 +5009,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -4972,6 +5022,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -4987,6 +5038,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -5007,6 +5059,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -5071,6 +5124,37 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -5082,6 +5166,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -5104,6 +5189,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -5131,6 +5217,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -5156,6 +5243,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -5182,6 +5270,7 @@ components: type: string required: - type + type: object CheckoutSessionInstallmentOption: properties: plans: @@ -5213,6 +5302,7 @@ components: format: int32 type: integer type: array + type: object CheckoutThreeDS2Action: additionalProperties: false properties: @@ -5242,6 +5332,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -5251,6 +5342,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -5260,6 +5352,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5330,6 +5423,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5338,6 +5432,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5358,6 +5453,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5389,6 +5485,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5417,6 +5514,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreateCheckoutSessionRequest: properties: accountInfo: @@ -5771,6 +5869,7 @@ components: - reference - returnUrl - merchantAccount + type: object CreateCheckoutSessionResponse: properties: accountInfo: @@ -6134,6 +6233,7 @@ components: - returnUrl - expiresAt - merchantAccount + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -6164,6 +6264,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -6175,6 +6276,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -6208,6 +6310,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -6224,6 +6327,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -6383,7 +6487,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -6441,6 +6545,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -6483,6 +6588,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -6494,6 +6600,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -6510,6 +6617,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: details: @@ -6529,6 +6637,7 @@ components: type: boolean required: - details + type: object DeviceRenderOptions: properties: sdkInterface: @@ -6570,6 +6679,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -6605,6 +6715,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -6647,6 +6758,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -6667,6 +6779,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -6693,6 +6806,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -6727,6 +6841,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -6738,6 +6853,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -6781,6 +6897,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -6798,6 +6915,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -6811,6 +6929,7 @@ components: type: array required: - accountScore + type: object FundOrigin: properties: billingAddress: @@ -6819,6 +6938,7 @@ components: shopperName: description: The name of the person $ref: '#/components/schemas/Name' + type: object FundRecipient: properties: billingAddress: @@ -6859,6 +6979,7 @@ components: walletOwnerTaxId: description: indicates the tax identifier of the fund recepient type: string + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -6893,6 +7014,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -6919,6 +7041,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -6958,6 +7081,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -6990,6 +7114,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -7028,6 +7153,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -7067,6 +7193,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -7095,6 +7222,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -7103,6 +7231,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -7111,6 +7240,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -7154,6 +7284,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -7191,6 +7322,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -7253,6 +7385,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -7279,6 +7412,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -7302,6 +7436,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -7313,6 +7448,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -7419,6 +7555,7 @@ components: x-addedInVersion: '68' description: Indicates shipping method chosen for the transaction. type: string + type: object MobilePayDetails: additionalProperties: false properties: @@ -7433,6 +7570,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -7454,6 +7592,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -7465,6 +7604,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -7502,6 +7642,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -7542,6 +7683,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -7577,6 +7719,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -7616,6 +7759,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -7663,6 +7807,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -7689,6 +7834,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -7736,6 +7882,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -7801,6 +7948,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -7905,6 +8053,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -8024,6 +8173,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentDonationRequest: properties: accountInfo: @@ -8559,6 +8709,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -8575,6 +8726,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -8739,7 +8891,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -8853,6 +9005,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brand: @@ -8898,6 +9051,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -8910,6 +9064,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodIssuer: properties: disabled: @@ -8927,6 +9082,7 @@ components: required: - id - name + type: object PaymentMethodsRequest: properties: additionalData: @@ -9035,6 +9191,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: paymentMethods: @@ -9049,6 +9206,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -9104,6 +9262,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -9628,6 +9787,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -9635,6 +9795,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -9765,6 +9926,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentReversalResource: properties: merchantAccount: @@ -9792,6 +9954,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -10240,6 +10403,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -10252,6 +10416,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -10261,6 +10426,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -10369,6 +10535,7 @@ components: - merchantReference - paymentMethod - shopperLocale + type: object Phone: properties: cc: @@ -10380,7 +10547,20 @@ components: description: 'Subscriber number. Maximum length: 15 characters.' maxLength: 15 type: string - PlatformChargebackLogic: {} + type: object + PlatformChargebackLogic: + properties: + behavior: + x-addedInVersion: '68' + enum: + - deductAccordingToSplitRatio + - deductFromLiableAccount + - deductFromOneBalanceAccount + type: string + targetAccount: + x-addedInVersion: '68' + type: string + type: object RatepayDetails: additionalProperties: false properties: @@ -10419,6 +10599,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -10456,6 +10637,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brand: @@ -10507,6 +10689,7 @@ components: type: description: The unique payment method code. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -10528,6 +10711,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -10559,6 +10743,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -10613,6 +10798,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -11050,6 +11236,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -11101,6 +11288,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -11114,6 +11302,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -11123,6 +11312,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -11151,6 +11341,7 @@ components: Example: OOFF' type: string + type: object RiskData: properties: clientData: @@ -11175,6 +11366,7 @@ components: description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string + type: object SDKEphemPubKey: properties: crv: @@ -11189,6 +11381,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -11227,6 +11420,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -11263,6 +11457,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -11289,6 +11484,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -11299,6 +11495,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -11349,6 +11546,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -11361,6 +11559,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -11408,6 +11607,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -11425,6 +11625,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -11451,6 +11652,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -11462,6 +11664,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -11514,6 +11717,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -11554,6 +11758,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -11578,6 +11783,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object SubMerchant: properties: city: @@ -11612,6 +11818,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object ThreeDS2RequestData: properties: acctInfo: @@ -11904,6 +12111,7 @@ components: $ref: '#/components/schemas/Phone' required: - deviceChannel + type: object ThreeDS2ResponseData: properties: acsChallengeMandated: @@ -11944,6 +12152,7 @@ components: type: string transStatusReason: type: string + type: object ThreeDS2Result: properties: authenticationValue: @@ -12046,6 +12255,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSRequestorAuthenticationInfo: properties: threeDSReqAuthData: @@ -12080,6 +12290,7 @@ components: maxLength: 12 minLength: 12 type: string + type: object ThreeDSRequestorPriorAuthenticationInfo: properties: threeDSReqPriorAuthData: @@ -12115,6 +12326,7 @@ components: maxLength: 36 minLength: 36 type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -12201,6 +12413,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -12234,6 +12447,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -12275,6 +12489,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -12307,6 +12522,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -12338,6 +12554,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -12366,6 +12583,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -12381,6 +12599,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -12399,6 +12618,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -12430,6 +12650,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -12551,7 +12772,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -12615,7 +12836,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -12641,6 +12862,9 @@ components: remainingAmount: currency: EUR value: 2500 + amount: + currency: EUR + value: 300 post-orders-cancel-basic: summary: Cancel an order value: @@ -14969,7 +15193,7 @@ components: encryptedSecurityCode: test_737 holderName: John Smith additionalData: - allow3DS2: true + allow3DS2: 'true' billingAddress: country: US city: New York @@ -14989,7 +15213,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -15011,6 +15235,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -15040,10 +15270,10 @@ components: cvcResultRaw: M refusalReasonRaw: AUTHORISED acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VEP3H - pspReference: 993617895204576J + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-card-securedfields: summary: Make a card payment (using encrypted card details) value: @@ -15070,10 +15300,10 @@ components: cvcResultRaw: M refusalReasonRaw: AUTHORISED acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VIE9N - pspReference: 993617895215577D + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-details-3d-secure-2-native: summary: Submit 3D Secure 2 authentication result value: @@ -15117,10 +15347,10 @@ components: refusalReasonRaw: AUTHORISED recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VC172 - pspReference: 993617895195570C + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-enableOneClick-raw: summary: Tokenize card details for one-off payments value: @@ -15155,10 +15385,10 @@ components: refusalReasonRaw: AUTHORISED recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VCKO0 - pspReference: 993617895197573E + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-payments-giropay: summary: Make a giropay payment value: @@ -15175,7 +15405,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 paymentMethodType: giropay url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA method: GET @@ -15216,7 +15445,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== paymentMethodType: ideal url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ method: GET @@ -15237,7 +15465,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -15261,22 +15489,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -15289,7 +15517,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -15317,6 +15545,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... @@ -15343,7 +15572,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== paymentMethodType: directEbanking url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA method: GET @@ -15416,10 +15644,10 @@ components: refusalReasonRaw: AUTHORISED recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID acquirerCode: TestPmmAcquirer - acquirerReference: 8PQMP9VD896 - pspReference: 993617895199574A + acquirerReference: YOUR_ACQUIRER_REFERENCE + pspReference: YOUR_PSP_REFERENCE resultCode: Authorised - merchantReference: string + merchantReference: YOUR_MERCHANT_REFERENCE post-sessions-00.success: summary: Create a payment session description: Example request for creating a payment session diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 6939004..cc97d08 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=69) to find out what changed in this version!' - x-timestamp: '2023-02-09T12:22:12Z' + x-timestamp: '2023-02-22T11:25:50Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -266,7 +266,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -399,7 +399,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -577,7 +577,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -666,7 +666,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1109,6 +1109,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1433,6 +1435,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2277,6 +2281,7 @@ components: x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. description: Shopper's work phone number (including the country code). type: string + type: object AcctInfo: properties: chAccAgeInd: @@ -2415,6 +2420,7 @@ components: in the previous year. Max length: 3 characters.' maxLength: 3 type: string + type: object AchDetails: additionalProperties: false properties: @@ -2471,6 +2477,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2539,6 +2546,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2820,6 +2828,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -2983,6 +2992,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -3002,6 +3012,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -3042,6 +3059,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -3143,6 +3164,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3303,6 +3325,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3426,6 +3449,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3517,6 +3541,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3528,6 +3553,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3556,6 +3582,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3589,6 +3616,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3667,6 +3695,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3726,6 +3755,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3803,6 +3833,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3860,6 +3891,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3881,6 +3913,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -3921,6 +3954,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -3960,6 +3994,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -3979,6 +4014,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -3993,6 +4029,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -4007,6 +4044,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -4047,6 +4085,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -4055,6 +4094,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -4081,6 +4121,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationData: properties: attemptAuthentication: @@ -4091,9 +4132,6 @@ components: - description: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined. value: never - - description: Do not perform 3D Secure authentication if not required by - PSD2 SCA or other national regulations. - value: preferNo description: 'Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure). @@ -4111,7 +4149,6 @@ components: enum: - always - never - - preferNo type: string authenticationOnly: x-addedInVersion: '69' @@ -4126,6 +4163,7 @@ components: description: Object with additional parameters for the 3D Secure authentication flow. $ref: '#/components/schemas/ThreeDSRequestData' + type: object Avs: properties: addressEditable: @@ -4143,6 +4181,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -4181,6 +4220,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -4229,6 +4269,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -4251,6 +4292,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -4279,6 +4321,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4336,6 +4379,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4402,6 +4446,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4410,6 +4455,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4501,11 +4547,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4540,6 +4583,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4547,6 +4591,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4564,6 +4609,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4584,6 +4630,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -4954,9 +5001,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -5015,6 +5061,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -5027,6 +5074,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -5042,6 +5090,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -5062,6 +5111,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -5126,6 +5176,37 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -5137,6 +5218,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -5159,6 +5241,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -5186,6 +5269,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -5211,6 +5295,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -5237,6 +5322,7 @@ components: type: string required: - type + type: object CheckoutSessionInstallmentOption: properties: plans: @@ -5268,6 +5354,7 @@ components: format: int32 type: integer type: array + type: object CheckoutThreeDS2Action: additionalProperties: false properties: @@ -5297,6 +5384,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -5306,6 +5394,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -5315,6 +5404,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5385,6 +5475,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5393,6 +5484,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5413,6 +5505,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5444,6 +5537,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5472,6 +5566,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreateCheckoutSessionRequest: properties: accountInfo: @@ -5830,6 +5925,7 @@ components: - reference - returnUrl - merchantAccount + type: object CreateCheckoutSessionResponse: properties: accountInfo: @@ -6197,6 +6293,7 @@ components: - returnUrl - expiresAt - merchantAccount + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -6227,6 +6324,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -6238,6 +6336,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -6271,6 +6370,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -6287,6 +6387,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -6466,7 +6567,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -6541,6 +6642,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -6583,6 +6685,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -6594,6 +6697,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -6610,6 +6714,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: authenticationData: @@ -6636,6 +6741,7 @@ components: type: boolean required: - details + type: object DetailsRequestAuthenticationData: properties: authenticationOnly: @@ -6646,6 +6752,7 @@ components: Default: *false**.' type: boolean + type: object DeviceRenderOptions: properties: sdkInterface: @@ -6687,6 +6794,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -6722,6 +6830,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -6764,6 +6873,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -6784,6 +6894,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -6810,6 +6921,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -6844,6 +6956,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -6855,6 +6968,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -6898,6 +7012,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -6915,6 +7030,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -6928,6 +7044,7 @@ components: type: array required: - accountScore + type: object FundOrigin: properties: billingAddress: @@ -6936,6 +7053,7 @@ components: shopperName: description: The name of the person $ref: '#/components/schemas/Name' + type: object FundRecipient: properties: billingAddress: @@ -6976,6 +7094,7 @@ components: walletOwnerTaxId: description: indicates the tax identifier of the fund recepient type: string + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -7010,6 +7129,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -7036,6 +7156,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -7075,6 +7196,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -7107,6 +7229,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -7145,6 +7268,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -7184,6 +7308,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -7212,6 +7337,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -7220,6 +7346,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -7228,6 +7355,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -7271,6 +7399,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -7308,6 +7437,7 @@ components: description: Tax percentage, in minor units. format: int64 type: integer + type: object Mandate: properties: amount: @@ -7370,6 +7500,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -7396,6 +7527,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -7419,6 +7551,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -7430,6 +7563,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -7536,6 +7670,7 @@ components: x-addedInVersion: '68' description: Indicates shipping method chosen for the transaction. type: string + type: object MobilePayDetails: additionalProperties: false properties: @@ -7550,6 +7685,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -7571,6 +7707,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -7582,6 +7719,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -7619,6 +7757,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -7659,6 +7798,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -7694,6 +7834,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -7733,6 +7874,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -7780,6 +7922,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -7806,6 +7949,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -7853,6 +7997,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -7918,6 +8063,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -8022,6 +8168,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -8146,6 +8293,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentDonationRequest: properties: accountInfo: @@ -8688,6 +8836,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -8704,6 +8853,7 @@ components: description: The payment amount and currency. $ref: '#/components/schemas/Amount' applicationInfo: + deprecated: true description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' @@ -8888,7 +9038,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -9019,6 +9169,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brand: @@ -9064,6 +9215,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -9076,6 +9228,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodIssuer: properties: disabled: @@ -9093,6 +9246,7 @@ components: required: - id - name + type: object PaymentMethodsRequest: properties: additionalData: @@ -9201,6 +9355,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: paymentMethods: @@ -9215,6 +9370,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -9270,6 +9426,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -9801,6 +9958,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -9808,6 +9966,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -9943,6 +10102,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentReversalResource: properties: merchantAccount: @@ -9970,6 +10130,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -10421,6 +10582,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -10433,6 +10595,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -10442,6 +10605,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -10546,6 +10710,7 @@ components: required: - merchantReference - shopperLocale + type: object Phone: properties: cc: @@ -10557,18 +10722,20 @@ components: description: 'Subscriber number. Maximum length: 15 characters.' maxLength: 15 type: string + type: object PlatformChargebackLogic: properties: behavior: - x-addedInVersion: '69' + x-addedInVersion: '68' enum: - deductAccordingToSplitRatio - deductFromLiableAccount - deductFromOneBalanceAccount type: string targetAccount: - x-addedInVersion: '69' + x-addedInVersion: '68' type: string + type: object RatepayDetails: additionalProperties: false properties: @@ -10607,6 +10774,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -10644,6 +10812,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brand: @@ -10695,6 +10864,7 @@ components: type: description: The unique payment method code. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -10716,6 +10886,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -10747,6 +10918,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -10801,6 +10973,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -11238,6 +11411,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -11289,6 +11463,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -11302,6 +11477,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -11311,6 +11487,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -11339,6 +11516,7 @@ components: Example: OOFF' type: string + type: object ResponsePaymentMethod: properties: brand: @@ -11349,6 +11527,7 @@ components: description: The `paymentMethod.type` value used in the request. type: string title: paymentResponse + type: object RiskData: properties: clientData: @@ -11373,6 +11552,7 @@ components: description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string + type: object SDKEphemPubKey: properties: crv: @@ -11387,6 +11567,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -11425,6 +11606,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -11461,6 +11643,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -11487,6 +11670,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -11497,6 +11681,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -11547,6 +11732,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -11559,6 +11745,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -11606,6 +11793,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -11623,6 +11811,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -11649,6 +11838,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -11660,6 +11850,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -11713,6 +11904,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -11753,6 +11945,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object SubInputDetail: properties: configuration: @@ -11777,6 +11970,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object SubMerchant: properties: city: @@ -11811,6 +12005,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object ThreeDS2RequestData: properties: acctInfo: @@ -12103,6 +12298,7 @@ components: $ref: '#/components/schemas/Phone' required: - deviceChannel + type: object ThreeDS2ResponseData: properties: acsChallengeMandated: @@ -12143,6 +12339,7 @@ components: type: string transStatusReason: type: string + type: object ThreeDS2Result: properties: authenticationValue: @@ -12245,6 +12442,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSRequestData: properties: challengeWindowSize: @@ -12313,6 +12511,7 @@ components: - 2.1.0 - 2.2.0 type: string + type: object ThreeDSRequestorAuthenticationInfo: properties: threeDSReqAuthData: @@ -12347,6 +12546,7 @@ components: maxLength: 12 minLength: 12 type: string + type: object ThreeDSRequestorPriorAuthenticationInfo: properties: threeDSReqPriorAuthData: @@ -12382,6 +12582,7 @@ components: maxLength: 36 minLength: 36 type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -12468,6 +12669,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -12501,6 +12703,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -12542,6 +12745,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -12574,6 +12778,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -12605,6 +12810,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -12633,6 +12839,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -12648,6 +12855,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -12666,6 +12874,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -12697,6 +12906,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -12818,7 +13028,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -12882,7 +13092,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -12908,6 +13118,9 @@ components: remainingAmount: currency: EUR value: 2500 + amount: + currency: EUR + value: 300 post-orders-cancel-basic: summary: Cancel an order value: @@ -15257,7 +15470,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -15279,6 +15492,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -15443,7 +15662,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 paymentMethodType: giropay url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA method: GET @@ -15484,7 +15702,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== paymentMethodType: ideal url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ method: GET @@ -15505,7 +15722,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -15529,22 +15746,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -15557,7 +15774,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -15585,6 +15802,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... @@ -15611,7 +15829,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== paymentMethodType: directEbanking url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA method: GET diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index f30a652..1729827 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -80,7 +80,7 @@ info: Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=70) to find out what changed in this version!' - x-timestamp: '2023-02-09T12:22:12Z' + x-timestamp: '2023-02-22T11:25:50Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -268,7 +268,7 @@ paths: operationId: post-cardDetails x-groupName: Payments x-sortIndex: 6 - x-methodName: listBrandsOnCard + x-methodName: cardDetails security: - BasicAuth: [] - ApiKeyAuth: [] @@ -401,7 +401,7 @@ paths: operationId: post-orders x-groupName: Orders x-sortIndex: 2 - x-methodName: createOrder + x-methodName: orders security: - BasicAuth: [] - ApiKeyAuth: [] @@ -579,7 +579,7 @@ paths: operationId: post-originKeys x-groupName: Utility x-sortIndex: 1 - x-methodName: createOriginkeyValuesForDomains + x-methodName: originKeys security: - BasicAuth: [] - ApiKeyAuth: [] @@ -668,7 +668,7 @@ paths: operationId: post-paymentLinks x-groupName: Payment links x-sortIndex: 1 - x-methodName: createPaymentLink + x-methodName: paymentLinks security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1111,6 +1111,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-paymentSession x-groupName: Classic Checkout SDK x-sortIndex: 1 @@ -1435,6 +1437,8 @@ paths: For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + deprecated: true + x-deprecatedInVersion: '37' operationId: post-payments-result x-groupName: Classic Checkout SDK x-sortIndex: 2 @@ -2367,6 +2371,7 @@ components: x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. description: Shopper's work phone number (including the country code). type: string + type: object AcctInfo: properties: chAccAgeInd: @@ -2505,6 +2510,7 @@ components: in the previous year. Max length: 3 characters.' maxLength: 3 type: string + type: object AchDetails: additionalProperties: false properties: @@ -2561,6 +2567,7 @@ components: required: - bankAccountNumber title: ACH Direct Debit + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -2629,6 +2636,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -2910,6 +2918,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -3073,6 +3082,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -3092,6 +3102,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -3132,6 +3149,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -3233,6 +3254,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -3393,6 +3415,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -3516,6 +3539,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -3607,6 +3631,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -3618,6 +3643,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -3646,6 +3672,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -3679,6 +3706,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -3757,6 +3785,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3816,6 +3845,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -3893,6 +3923,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -3950,6 +3981,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -3971,6 +4003,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -4011,6 +4044,7 @@ components: - city - postalCode - country + type: object AfterpayDetails: additionalProperties: false properties: @@ -4050,6 +4084,7 @@ components: required: - type title: Afterpay + type: object AmazonPayDetails: additionalProperties: false properties: @@ -4069,6 +4104,7 @@ components: - amazonpay type: string title: Amazon Pay + type: object Amount: properties: currency: @@ -4083,6 +4119,7 @@ components: required: - value - currency + type: object AndroidPayDetails: additionalProperties: false properties: @@ -4097,6 +4134,7 @@ components: - androidpay type: string title: Android Pay + type: object ApplePayDetails: additionalProperties: false properties: @@ -4137,6 +4175,7 @@ components: required: - applePayToken title: Apple Pay + type: object ApplePaySessionResponse: properties: data: @@ -4145,6 +4184,7 @@ components: type: string required: - data + type: object ApplicationInfo: properties: adyenLibrary: @@ -4171,6 +4211,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationData: properties: attemptAuthentication: @@ -4181,9 +4222,6 @@ components: - description: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined. value: never - - description: Do not perform 3D Secure authentication if not required by - PSD2 SCA or other national regulations. - value: preferNo description: 'Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure). @@ -4201,7 +4239,6 @@ components: enum: - always - never - - preferNo type: string authenticationOnly: x-addedInVersion: '69' @@ -4216,6 +4253,7 @@ components: description: Object with additional parameters for the 3D Secure authentication flow. $ref: '#/components/schemas/ThreeDSRequestData' + type: object Avs: properties: addressEditable: @@ -4233,6 +4271,7 @@ components: - 'no' - automatic type: string + type: object BacsDirectDebitDetails: additionalProperties: false properties: @@ -4271,6 +4310,7 @@ components: - directdebit_GB type: string title: BACS Direct Debit + type: object BankAccount: properties: bankAccountNumber: @@ -4319,6 +4359,7 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BillDeskDetails: additionalProperties: false properties: @@ -4341,6 +4382,7 @@ components: - type - issuer title: BillDesk + type: object BlikDetails: additionalProperties: false properties: @@ -4369,6 +4411,7 @@ components: - blik type: string title: BLIK + type: object BrowserInfo: properties: acceptHeader: @@ -4426,6 +4469,7 @@ components: - screenWidth - timeZoneOffset - language + type: object Card: properties: cvc: @@ -4492,6 +4536,7 @@ components: required: - expiryYear - holderName + type: object CardBrandDetails: properties: supported: @@ -4500,6 +4545,7 @@ components: type: description: The name of the card brand. type: string + type: object CardDetails: additionalProperties: false properties: @@ -4591,11 +4637,8 @@ components: - alliancedata - card type: string - required: - - encryptedCardNumber - - encryptedExpiryMonth - - encryptedExpiryYear title: Card + type: object CardDetailsRequest: properties: cardNumber: @@ -4630,6 +4673,7 @@ components: required: - cardNumber - merchantAccount + type: object CardDetailsResponse: properties: brands: @@ -4637,6 +4681,7 @@ components: items: $ref: '#/components/schemas/CardBrandDetails' type: array + type: object CellulantDetails: additionalProperties: false properties: @@ -4654,6 +4699,7 @@ components: - cellulant type: string title: Cellulant + type: object CheckoutAwaitAction: additionalProperties: false properties: @@ -4674,6 +4720,7 @@ components: type: string required: - type + type: object CheckoutBalanceCheckRequest: properties: accountInfo: @@ -5044,9 +5091,8 @@ components: type: boolean required: - merchantAccount - - reference - - amount - paymentMethod + type: object CheckoutBalanceCheckResponse: properties: additionalData: @@ -5105,6 +5151,7 @@ components: required: - balance - resultCode + type: object CheckoutCancelOrderRequest: properties: merchantAccount: @@ -5117,6 +5164,7 @@ components: required: - order - merchantAccount + type: object CheckoutCancelOrderResponse: properties: pspReference: @@ -5132,6 +5180,7 @@ components: required: - pspReference - resultCode + type: object CheckoutCreateOrderRequest: properties: amount: @@ -5152,6 +5201,7 @@ components: - merchantAccount - reference - amount + type: object CheckoutCreateOrderResponse: properties: additionalData: @@ -5216,6 +5266,37 @@ components: - expiresAt - orderData - resultCode + type: object + CheckoutNativeRedirectAction: + additionalProperties: false + properties: + data: + additionalProperties: + type: string + description: When the redirect URL must be accessed via POST, use this data + to post to the redirect URL. + type: object + method: + description: Specifies the HTTP method, for example GET or POST. + type: string + nativeRedirectData: + description: Native SDK's redirect data containing the direct issuer link + and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: '**nativeRedirect**' + enum: + - nativeRedirect + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + type: object CheckoutOrder: properties: orderData: @@ -5227,6 +5308,7 @@ components: required: - pspReference - orderData + type: object CheckoutOrderResponse: properties: amount: @@ -5249,6 +5331,7 @@ components: $ref: '#/components/schemas/Amount' required: - pspReference + type: object CheckoutQrCodeAction: additionalProperties: false properties: @@ -5276,6 +5359,7 @@ components: type: string required: - type + type: object CheckoutRedirectAction: additionalProperties: false properties: @@ -5301,6 +5385,7 @@ components: type: string required: - type + type: object CheckoutSDKAction: additionalProperties: false properties: @@ -5327,6 +5412,7 @@ components: type: string required: - type + type: object CheckoutSessionInstallmentOption: properties: plans: @@ -5358,6 +5444,7 @@ components: format: int32 type: integer type: array + type: object CheckoutThreeDS2Action: additionalProperties: false properties: @@ -5387,6 +5474,7 @@ components: type: string required: - type + type: object CheckoutUtilityRequest: properties: originDomains: @@ -5396,6 +5484,7 @@ components: type: array required: - originDomains + type: object CheckoutUtilityResponse: properties: originKeys: @@ -5405,6 +5494,7 @@ components: description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. type: object + type: object CheckoutVoucherAction: additionalProperties: false properties: @@ -5475,6 +5565,7 @@ components: type: string required: - type + type: object CommonField: properties: name: @@ -5483,6 +5574,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object Company: properties: homepage: @@ -5503,6 +5595,7 @@ components: type: description: The company type. type: string + type: object Configuration: properties: avs: @@ -5534,6 +5627,7 @@ components: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' + type: object CreateApplePaySessionRequest: properties: displayName: @@ -5562,6 +5656,7 @@ components: - domainName - merchantIdentifier - displayName + type: object CreateCheckoutSessionRequest: properties: accountInfo: @@ -5934,6 +6029,7 @@ components: - reference - returnUrl - merchantAccount + type: object CreateCheckoutSessionResponse: properties: accountInfo: @@ -6327,6 +6423,7 @@ components: - returnUrl - expiresAt - merchantAccount + type: object CreatePaymentAmountUpdateRequest: properties: amount: @@ -6359,6 +6456,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentCancelRequest: properties: merchantAccount: @@ -6370,6 +6468,7 @@ components: type: string required: - merchantAccount + type: object CreatePaymentCaptureRequest: properties: amount: @@ -6403,6 +6502,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentLinkRequest: properties: allowedPaymentMethods: @@ -6594,7 +6694,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -6669,6 +6769,7 @@ components: - amount - reference - merchantAccount + type: object CreatePaymentRefundRequest: properties: amount: @@ -6711,6 +6812,7 @@ components: required: - merchantAccount - amount + type: object CreatePaymentReversalRequest: properties: merchantAccount: @@ -6722,6 +6824,7 @@ components: type: string required: - merchantAccount + type: object CreateStandalonePaymentCancelRequest: properties: merchantAccount: @@ -6738,6 +6841,7 @@ components: required: - merchantAccount - paymentReference + type: object DetailsRequest: properties: authenticationData: @@ -6764,6 +6868,7 @@ components: type: boolean required: - details + type: object DetailsRequestAuthenticationData: properties: authenticationOnly: @@ -6774,6 +6879,7 @@ components: Default: *false**.' type: boolean + type: object DeviceRenderOptions: properties: sdkInterface: @@ -6815,6 +6921,7 @@ components: - text type: string type: array + type: object DokuDetails: additionalProperties: false properties: @@ -6850,6 +6957,7 @@ components: - lastName - shopperEmail title: Doku + type: object DonationResponse: properties: amount: @@ -6892,6 +7000,7 @@ components: - pending - refused type: string + type: object DotpayDetails: additionalProperties: false properties: @@ -6912,6 +7021,7 @@ components: required: - issuer title: Dotpay + type: object DragonpayDetails: additionalProperties: false properties: @@ -6938,6 +7048,7 @@ components: - type - issuer title: Dragonpay + type: object EcontextVoucherDetails: additionalProperties: false properties: @@ -6972,6 +7083,7 @@ components: - shopperEmail - telephoneNumber title: Voucher + type: object ExternalPlatform: properties: integrator: @@ -6983,6 +7095,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -7026,6 +7139,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -7043,6 +7157,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -7056,6 +7171,7 @@ components: type: array required: - accountScore + type: object FundOrigin: properties: billingAddress: @@ -7064,6 +7180,7 @@ components: shopperName: description: The name of the person $ref: '#/components/schemas/Name' + type: object FundRecipient: properties: billingAddress: @@ -7104,6 +7221,7 @@ components: walletOwnerTaxId: description: indicates the tax identifier of the fund recepient type: string + type: object GenericIssuerPaymentMethodDetails: additionalProperties: false properties: @@ -7138,6 +7256,7 @@ components: - type - issuer title: Stored Payment Method + type: object GiropayDetails: additionalProperties: false properties: @@ -7164,6 +7283,7 @@ components: - giropay type: string title: Giropay + type: object GooglePayDetails: additionalProperties: false properties: @@ -7203,6 +7323,7 @@ components: required: - googlePayToken title: Google Pay + type: object IdealDetails: additionalProperties: false properties: @@ -7235,6 +7356,7 @@ components: required: - issuer title: iDEAL + type: object InputDetail: properties: configuration: @@ -7273,6 +7395,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object InstallmentOption: properties: maxValue: @@ -7312,6 +7435,7 @@ components: format: int32 type: integer type: array + type: object Installments: properties: plan: @@ -7340,6 +7464,7 @@ components: type: integer required: - value + type: object InstallmentsNumber: properties: maxNumberOfInstallments: @@ -7348,6 +7473,7 @@ components: type: integer required: - maxNumberOfInstallments + type: object Item: properties: id: @@ -7356,6 +7482,7 @@ components: name: description: The display name. type: string + type: object KlarnaDetails: additionalProperties: false properties: @@ -7399,6 +7526,7 @@ components: required: - type title: Klarna + type: object LineItem: properties: amountExcludingTax: @@ -7465,6 +7593,7 @@ components: x-addedInVersion: '70' description: Universal Product Code. type: string + type: object ListStoredPaymentMethodsResponse: properties: merchantAccount: @@ -7482,6 +7611,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethodResource' type: array + type: object Mandate: properties: amount: @@ -7544,6 +7674,7 @@ components: - frequency - amount - endsAt + type: object MasterpassDetails: additionalProperties: false properties: @@ -7570,6 +7701,7 @@ components: required: - masterpassTransactionId title: Masterpass + type: object MbwayDetails: additionalProperties: false properties: @@ -7593,6 +7725,7 @@ components: - telephoneNumber - shopperEmail title: MBWay + type: object MerchantDevice: properties: os: @@ -7604,6 +7737,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -7710,6 +7844,7 @@ components: x-addedInVersion: '68' description: Indicates shipping method chosen for the transaction. type: string + type: object MobilePayDetails: additionalProperties: false properties: @@ -7724,6 +7859,7 @@ components: - mobilepay type: string title: MobilePay + type: object MolPayDetails: additionalProperties: false properties: @@ -7745,6 +7881,7 @@ components: - type - issuer title: MOLPay + type: object Name: properties: firstName: @@ -7756,6 +7893,7 @@ components: required: - firstName - lastName + type: object OpenInvoiceDetails: additionalProperties: false properties: @@ -7793,6 +7931,7 @@ components: - atome_pos type: string title: Open Invoice + type: object PayPalDetails: additionalProperties: false properties: @@ -7833,6 +7972,7 @@ components: required: - type title: PayPal + type: object PayUUpiDetails: additionalProperties: false properties: @@ -7868,6 +8008,7 @@ components: required: - type title: PayU + type: object PayWithGoogleDetails: additionalProperties: false properties: @@ -7907,6 +8048,7 @@ components: required: - googlePayToken title: Google Pay + type: object PaymentAmountUpdateResource: properties: amount: @@ -7956,6 +8098,7 @@ components: - reference - pspReference - paymentPspReference + type: object PaymentCancelResource: properties: merchantAccount: @@ -7982,6 +8125,7 @@ components: - merchantAccount - paymentPspReference - pspReference + type: object PaymentCaptureResource: properties: amount: @@ -8029,6 +8173,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentCompletionDetails: properties: MD: @@ -8094,6 +8239,7 @@ components: challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 type: string + type: object PaymentDetails: additionalProperties: false properties: @@ -8198,6 +8344,7 @@ components: - balanceplatform type: string title: Payment Details + type: object PaymentDetailsResponse: properties: additionalData: @@ -8322,6 +8469,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentDonationRequest: properties: accountInfo: @@ -8873,6 +9021,7 @@ components: - returnUrl - paymentMethod - donationAccount + type: object PaymentLinkResponse: properties: allowedPaymentMethods: @@ -9069,7 +9218,7 @@ components: For a list of shopper locales that Pay by Link supports, refer to [Language - and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).' type: string shopperName: description: The shopper's full name. This object is required for some payment @@ -9200,6 +9349,7 @@ components: - id - url - status + type: object PaymentMethod: properties: brand: @@ -9245,6 +9395,7 @@ components: type: description: The unique payment method code. type: string + type: object PaymentMethodGroup: properties: name: @@ -9257,6 +9408,7 @@ components: type: description: The unique code of the group. type: string + type: object PaymentMethodIssuer: properties: disabled: @@ -9274,6 +9426,7 @@ components: required: - id - name + type: object PaymentMethodsRequest: properties: additionalData: @@ -9382,6 +9535,7 @@ components: type: string required: - merchantAccount + type: object PaymentMethodsResponse: properties: paymentMethods: @@ -9396,6 +9550,7 @@ components: items: $ref: '#/components/schemas/StoredPaymentMethod' type: array + type: object PaymentRefundResource: properties: amount: @@ -9451,6 +9606,7 @@ components: - amount - pspReference - paymentPspReference + type: object PaymentRequest: properties: accountInfo: @@ -9991,6 +10147,7 @@ components: - amount - returnUrl - paymentMethod + type: object PaymentResponse: properties: action: @@ -9998,6 +10155,7 @@ components: description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' @@ -10133,6 +10291,7 @@ components: description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string + type: object PaymentReversalResource: properties: merchantAccount: @@ -10160,6 +10319,7 @@ components: - merchantAccount - pspReference - paymentPspReference + type: object PaymentSetupRequest: properties: additionalData: @@ -10611,6 +10771,7 @@ components: - amount - returnUrl - countryCode + type: object PaymentSetupResponse: properties: paymentSession: @@ -10623,6 +10784,7 @@ components: items: $ref: '#/components/schemas/RecurringDetail' type: array + type: object PaymentVerificationRequest: properties: payload: @@ -10632,6 +10794,7 @@ components: type: string required: - payload + type: object PaymentVerificationResponse: properties: additionalData: @@ -10736,6 +10899,7 @@ components: required: - merchantReference - shopperLocale + type: object Phone: properties: cc: @@ -10747,18 +10911,20 @@ components: description: 'Subscriber number. Maximum length: 15 characters.' maxLength: 15 type: string + type: object PlatformChargebackLogic: properties: behavior: - x-addedInVersion: '69' + x-addedInVersion: '68' enum: - deductAccordingToSplitRatio - deductFromLiableAccount - deductFromOneBalanceAccount type: string targetAccount: - x-addedInVersion: '69' + x-addedInVersion: '68' type: string + type: object RatepayDetails: additionalProperties: false properties: @@ -10797,6 +10963,7 @@ components: required: - type title: Ratepay + type: object Recurring: properties: contract: @@ -10834,6 +11001,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RecurringDetail: properties: brand: @@ -10885,6 +11053,7 @@ components: type: description: The unique payment method code. type: string + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -10906,6 +11075,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -10937,6 +11107,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -10991,6 +11162,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -11428,6 +11600,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -11479,6 +11652,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -11492,6 +11666,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -11501,6 +11676,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -11529,6 +11705,7 @@ components: Example: OOFF' type: string + type: object ResponsePaymentMethod: properties: brand: @@ -11539,6 +11716,7 @@ components: description: The `paymentMethod.type` value used in the request. type: string title: paymentResponse + type: object RiskData: properties: clientData: @@ -11563,6 +11741,7 @@ components: description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string + type: object SDKEphemPubKey: properties: crv: @@ -11577,6 +11756,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object SamsungPayDetails: additionalProperties: false properties: @@ -11615,6 +11795,7 @@ components: required: - samsungPayToken title: Samsung Pay + type: object SepaDirectDebitDetails: additionalProperties: false properties: @@ -11651,6 +11832,7 @@ components: - iban - ownerName title: SEPA Direct Debit + type: object ServiceError: properties: additionalData: @@ -11677,6 +11859,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ServiceError-2: properties: errorCode: @@ -11687,6 +11870,7 @@ components: type: string pspReference: type: string + type: object ShopperInput: properties: billingAddress: @@ -11737,6 +11921,7 @@ components: - hidden - readOnly type: string + type: object ShopperInteractionDevice: properties: locale: @@ -11749,6 +11934,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -11796,6 +11982,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -11813,6 +12000,7 @@ components: type: integer required: - value + type: object StandalonePaymentCancelResource: properties: merchantAccount: @@ -11839,6 +12027,7 @@ components: - merchantAccount - pspReference - paymentReference + type: object StoredDetails: properties: bank: @@ -11850,6 +12039,7 @@ components: emailAddress: description: The email associated with stored payment details. type: string + type: object StoredPaymentMethod: properties: brand: @@ -11910,6 +12100,7 @@ components: type: description: The type of payment method. type: string + type: object StoredPaymentMethodDetails: additionalProperties: false properties: @@ -11950,6 +12141,7 @@ components: - truemoney type: string title: Stored Payment Method + type: object StoredPaymentMethodResource: properties: brand: @@ -12031,6 +12223,7 @@ components: type: description: The type of payment method. type: string + type: object SubInputDetail: properties: configuration: @@ -12055,6 +12248,7 @@ components: value: description: The value can be pre-filled, if available. type: string + type: object SubMerchant: properties: city: @@ -12089,6 +12283,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object ThreeDS2RequestData: properties: acctInfo: @@ -12381,6 +12576,7 @@ components: $ref: '#/components/schemas/Phone' required: - deviceChannel + type: object ThreeDS2ResponseData: properties: acsChallengeMandated: @@ -12421,6 +12617,7 @@ components: type: string transStatusReason: type: string + type: object ThreeDS2Result: properties: authenticationValue: @@ -12523,6 +12720,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDSRequestData: properties: challengeWindowSize: @@ -12591,6 +12789,7 @@ components: - 2.1.0 - 2.2.0 type: string + type: object ThreeDSRequestorAuthenticationInfo: properties: threeDSReqAuthData: @@ -12625,6 +12824,7 @@ components: maxLength: 12 minLength: 12 type: string + type: object ThreeDSRequestorPriorAuthenticationInfo: properties: threeDSReqPriorAuthData: @@ -12660,6 +12860,7 @@ components: maxLength: 36 minLength: 36 type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -12746,6 +12947,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object UpdatePaymentLinkRequest: properties: status: @@ -12779,6 +12981,7 @@ components: type: string required: - status + type: object UpiCollectDetails: additionalProperties: false properties: @@ -12820,6 +13023,7 @@ components: - type - billingSequenceNumber title: UPI Collect + type: object UpiIntentDetails: additionalProperties: false properties: @@ -12852,6 +13056,7 @@ components: required: - type title: UPI Intent + type: object VippsDetails: additionalProperties: false properties: @@ -12883,6 +13088,7 @@ components: required: - telephoneNumber title: Vipps + type: object VisaCheckoutDetails: additionalProperties: false properties: @@ -12911,6 +13117,7 @@ components: required: - visaCheckoutCallId title: Visa Checkout + type: object WeChatPayDetails: additionalProperties: false properties: @@ -12926,6 +13133,7 @@ components: - wechatpay_pos type: string title: WeChat Pay + type: object WeChatPayMiniProgramDetails: additionalProperties: false properties: @@ -12944,6 +13152,7 @@ components: - wechatpayMiniProgram type: string title: WeChat Pay - Mini Program + type: object ZipDetails: additionalProperties: false properties: @@ -12975,6 +13184,7 @@ components: - zip_pos type: string title: Zip + type: object securitySchemes: ApiKeyAuth: in: header @@ -13096,7 +13306,7 @@ components: - type: visa supported: true - type: cartebancaire - supported: 'true' + supported: true post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the @@ -13160,7 +13370,7 @@ components: reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme - storedPaymentMethodId: '8415718415172200' + recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT @@ -13186,6 +13396,9 @@ components: remainingAmount: currency: EUR value: 2500 + amount: + currency: EUR + value: 300 post-orders-cancel-basic: summary: Cancel an order value: @@ -15535,7 +15748,7 @@ components: screenWidth: 1536 timeZoneOffset: 0 javaEnabled: true - channel: web + channel: Web origin: https://your-company.com returnUrl: https://your-company.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -15557,6 +15770,12 @@ components: userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0 acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + javaEnabled: true + colorDepth: 10 + screenHeight: 2000 + screenWidth: 3000 + timeZoneOffset: 5 + language: en returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct: @@ -15721,7 +15940,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 paymentMethodType: giropay url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA method: GET @@ -15762,7 +15980,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== paymentMethodType: ideal url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ method: GET @@ -15783,7 +16000,7 @@ components: type: klarna amount: currency: SEK - value: '1000' + value: 1000 shopperLocale: en_US countryCode: SE telephoneNumber: +46 840 839 298 @@ -15807,22 +16024,22 @@ components: street: Stargatan returnUrl: https://www.your-company.com/... lineItems: - - quantity: '1' - amountExcludingTax: '331' - taxPercentage: '2100' + - quantity: 1 + amountExcludingTax: 331 + taxPercentage: 2100 description: Shoes id: 'Item #1' - taxAmount: '69' - amountIncludingTax: '400' + taxAmount: 69 + amountIncludingTax: 400 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM - - quantity: '2' - amountExcludingTax: '248' - taxPercentage: '2100' + - quantity: 2 + amountExcludingTax: 248 + taxPercentage: 2100 description: Socks id: 'Item #2' - taxAmount: '52' - amountIncludingTax: '300' + taxAmount: 52 + amountIncludingTax: 300 productUrl: URL_TO_PURCHASED_ITEM imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM post-payments-oneclick-direct: @@ -15835,7 +16052,7 @@ components: paymentMethod: type: scheme storedPaymentMethodId: '8416038790273850' - cardDetails.cvc: '737' + cvc: '737' shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT @@ -15863,6 +16080,7 @@ components: value: 1000 reference: Your order number paymentMethod: + type: scheme storedPaymentMethodId: '8316038796685850' shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription returnUrl: https://your-company.com/... @@ -15889,7 +16107,6 @@ components: value: resultCode: RedirectShopper action: - paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== paymentMethodType: directEbanking url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA method: GET diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 7c0f87d..91f2af9 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v25/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:08Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -55,7 +55,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -141,7 +141,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -219,7 +219,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -298,7 +298,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -389,7 +389,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -479,7 +479,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -560,7 +560,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -688,6 +688,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -969,6 +970,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1132,6 +1134,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1151,6 +1154,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1191,6 +1201,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1292,6 +1306,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -1452,6 +1467,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -1575,12 +1591,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -1672,6 +1690,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -1683,6 +1702,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -1711,6 +1731,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -1744,6 +1765,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -1822,6 +1844,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -1881,6 +1904,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -1958,6 +1982,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2015,6 +2040,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2036,6 +2062,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2076,6 +2103,7 @@ components: - city - postalCode - country + type: object Amount: properties: currency: @@ -2090,6 +2118,7 @@ components: required: - value - currency + type: object BankAccount: properties: bankAccountNumber: @@ -2138,21 +2167,19 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent - acceptHeader + type: object CancelOrRefundRequest: properties: additionalData: @@ -2216,6 +2243,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -2279,6 +2307,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -2348,6 +2377,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -2412,10 +2442,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object ForexQuote: properties: account: @@ -2459,6 +2488,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -2476,6 +2506,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -2489,6 +2520,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -2503,6 +2535,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -2565,6 +2598,7 @@ components: - frequency - amount - endsAt + type: object ModificationResult: properties: additionalData: @@ -2594,6 +2628,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -2605,6 +2640,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: additionalAmount: @@ -2687,7 +2723,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -2917,6 +2953,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: additionalAmount: @@ -2988,7 +3025,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3206,6 +3243,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentResult: properties: additionalData: @@ -3326,6 +3364,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -3352,6 +3391,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -3421,6 +3461,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -3442,6 +3483,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3473,6 +3515,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -3527,6 +3570,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -3955,6 +3999,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -4006,6 +4051,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -4019,6 +4065,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -4028,6 +4075,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -4056,6 +4104,7 @@ components: Example: OOFF' type: string + type: object ServiceError: properties: errorCode: @@ -4074,6 +4123,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ThreeDSecureData: properties: authenticationResponse: @@ -4121,6 +4171,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -4189,6 +4240,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 7e27d5a..fa176b1 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v30/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:08Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -227,7 +227,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -384,7 +384,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -475,7 +475,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -565,7 +565,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -643,7 +643,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -724,7 +724,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -852,6 +852,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1133,6 +1134,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1296,6 +1298,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1315,6 +1318,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1355,6 +1365,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1456,6 +1470,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -1616,6 +1631,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -1739,12 +1755,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -1836,6 +1854,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -1847,6 +1866,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -1875,6 +1895,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -1908,6 +1929,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -1986,6 +2008,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2045,6 +2068,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2122,6 +2146,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2179,6 +2204,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2200,6 +2226,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2240,6 +2267,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2313,6 +2341,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2327,6 +2356,7 @@ components: required: - value - currency + type: object BankAccount: properties: bankAccountNumber: @@ -2375,21 +2405,19 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent - acceptHeader + type: object CancelOrRefundRequest: properties: additionalData: @@ -2457,6 +2485,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -2524,6 +2553,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -2597,6 +2627,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -2661,10 +2692,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object ForexQuote: properties: account: @@ -2708,6 +2738,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -2725,6 +2756,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -2738,6 +2770,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -2752,6 +2785,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -2814,6 +2848,7 @@ components: - frequency - amount - endsAt + type: object ModificationResult: properties: additionalData: @@ -2843,6 +2878,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -2854,6 +2890,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: additionalAmount: @@ -2936,7 +2973,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3183,6 +3220,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: additionalAmount: @@ -3254,7 +3292,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3489,6 +3527,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentResult: properties: additionalData: @@ -3609,6 +3648,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -3635,6 +3675,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -3708,6 +3749,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -3729,6 +3771,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -3760,6 +3803,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -3814,6 +3858,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -4242,6 +4287,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -4293,6 +4339,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -4306,6 +4353,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -4315,6 +4363,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -4343,6 +4392,7 @@ components: Example: OOFF' type: string + type: object ServiceError: properties: errorCode: @@ -4361,6 +4411,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object TechnicalCancelRequest: properties: additionalData: @@ -4422,6 +4473,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDSecureData: properties: authenticationResponse: @@ -4469,6 +4521,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -4541,6 +4594,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index f66b839..1c2ef2c 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v40/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:08Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -719,7 +719,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -791,7 +791,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -866,7 +866,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -947,7 +947,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1170,6 +1170,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1231,6 +1232,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1512,6 +1514,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1675,6 +1678,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1694,6 +1698,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1734,6 +1745,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1835,6 +1850,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -1995,6 +2011,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2118,12 +2135,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2215,6 +2234,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2226,6 +2246,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2254,6 +2275,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2287,6 +2309,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2365,6 +2388,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2424,6 +2448,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2501,6 +2526,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2558,6 +2584,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2579,6 +2606,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2619,6 +2647,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2700,6 +2729,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2714,6 +2744,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2740,6 +2771,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object BankAccount: properties: bankAccountNumber: @@ -2788,12 +2820,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2837,8 +2868,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2849,6 +2878,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -2916,6 +2946,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -2991,6 +3022,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3072,6 +3104,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3136,10 +3169,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3148,6 +3180,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3189,6 +3222,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3224,6 +3258,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3235,6 +3270,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3278,6 +3314,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3295,6 +3332,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3308,6 +3346,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -3322,6 +3361,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3384,6 +3424,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3395,6 +3436,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3472,6 +3514,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3501,6 +3544,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3512,6 +3556,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3606,7 +3651,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3878,6 +3923,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -3961,7 +4007,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4221,6 +4267,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4304,7 +4351,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4563,6 +4610,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4683,6 +4731,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4720,6 +4769,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -4801,6 +4851,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -4822,6 +4873,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -4853,6 +4905,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -4907,6 +4960,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5351,6 +5405,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5402,6 +5457,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5415,6 +5471,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5424,6 +5481,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5452,6 +5510,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5466,6 +5525,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: errorCode: @@ -5484,6 +5544,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5496,6 +5557,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5543,6 +5605,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5560,6 +5623,7 @@ components: type: integer required: - value + type: object TechnicalCancelRequest: properties: additionalData: @@ -5629,6 +5693,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS2RequestData: properties: authenticationOnly: @@ -5741,6 +5806,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -5767,6 +5833,7 @@ components: description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -5779,11 +5846,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -5840,6 +5909,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -5920,6 +5990,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index e095798..5bbdbcd 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v46/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:09Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -719,7 +719,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -791,7 +791,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -866,7 +866,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -947,7 +947,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1170,6 +1170,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1231,6 +1232,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1512,6 +1514,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1675,6 +1678,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1694,6 +1698,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1734,6 +1745,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1835,6 +1850,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -1995,6 +2011,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2118,12 +2135,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2215,6 +2234,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2226,6 +2246,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2254,6 +2275,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2287,6 +2309,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2365,6 +2388,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2424,6 +2448,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2501,6 +2526,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2558,6 +2584,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2579,6 +2606,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2619,6 +2647,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2705,6 +2734,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2719,6 +2749,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2745,6 +2776,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object BankAccount: properties: bankAccountNumber: @@ -2793,12 +2825,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2842,8 +2873,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2854,6 +2883,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -2926,6 +2956,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3006,6 +3037,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3092,6 +3124,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3156,10 +3189,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3168,6 +3200,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3209,6 +3242,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3244,6 +3278,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3255,6 +3290,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3298,6 +3334,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3315,6 +3352,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3328,6 +3366,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -3342,6 +3381,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3404,6 +3444,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3415,6 +3456,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3492,6 +3534,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3521,6 +3564,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3532,6 +3576,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3626,7 +3671,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3898,6 +3943,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -3981,7 +4027,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4241,6 +4287,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4324,7 +4371,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4583,6 +4630,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4703,6 +4751,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4740,6 +4789,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -4826,6 +4876,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -4847,6 +4898,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -4878,6 +4930,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -4932,6 +4985,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5376,6 +5430,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5427,6 +5482,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5440,6 +5496,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5449,6 +5506,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5477,6 +5535,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5491,6 +5550,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5517,6 +5577,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5529,6 +5590,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5576,6 +5638,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5593,6 +5656,7 @@ components: type: integer required: - value + type: object TechnicalCancelRequest: properties: additionalData: @@ -5667,6 +5731,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS2RequestData: properties: authenticationOnly: @@ -5779,6 +5844,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -5805,6 +5871,7 @@ components: description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -5817,11 +5884,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -5878,6 +5947,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -5963,6 +6033,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 0d61de8..73c7e67 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v49/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:09Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -719,7 +719,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -791,7 +791,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -866,7 +866,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -947,7 +947,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1170,6 +1170,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1231,6 +1232,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1512,6 +1514,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1675,6 +1678,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1694,6 +1698,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1734,6 +1745,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1835,6 +1850,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -1995,6 +2011,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2118,12 +2135,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2215,6 +2234,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2226,6 +2246,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2254,6 +2275,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2287,6 +2309,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2365,6 +2388,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2424,6 +2448,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2501,6 +2526,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2558,6 +2584,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2579,6 +2606,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2619,6 +2647,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2705,6 +2734,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2719,6 +2749,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2745,6 +2776,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object BankAccount: properties: bankAccountNumber: @@ -2793,12 +2825,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2842,8 +2873,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2854,6 +2883,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -2926,6 +2956,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3006,6 +3037,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3092,6 +3124,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3156,10 +3189,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3168,6 +3200,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3209,6 +3242,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3244,6 +3278,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3255,6 +3290,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3298,6 +3334,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3315,6 +3352,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3328,6 +3366,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -3342,6 +3381,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3404,6 +3444,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3415,6 +3456,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3492,6 +3534,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3521,6 +3564,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3532,6 +3576,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3626,7 +3671,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3898,6 +3943,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -3981,7 +4027,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4241,6 +4287,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4324,7 +4371,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4583,6 +4630,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4703,6 +4751,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4740,6 +4789,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -4826,6 +4876,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -4847,6 +4898,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -4878,6 +4930,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -4932,6 +4985,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5376,6 +5430,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5427,6 +5482,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5440,6 +5496,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5449,6 +5506,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5477,6 +5535,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5491,6 +5550,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5517,6 +5577,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5529,6 +5590,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5576,6 +5638,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5593,6 +5656,7 @@ components: type: integer required: - value + type: object TechnicalCancelRequest: properties: additionalData: @@ -5667,6 +5731,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -5815,6 +5880,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -5849,6 +5915,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -5861,11 +5928,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -5922,6 +5991,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6007,6 +6077,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index 0d5f57d..fdd5557 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v50/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:09Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -719,7 +719,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -791,7 +791,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -866,7 +866,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -947,7 +947,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1187,6 +1187,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1248,6 +1249,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1529,6 +1531,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1692,6 +1695,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1711,6 +1715,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1751,6 +1762,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1852,6 +1867,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2012,6 +2028,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2135,12 +2152,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2232,6 +2251,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2243,6 +2263,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2271,6 +2292,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2304,6 +2326,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2382,6 +2405,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2441,6 +2465,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2518,6 +2543,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2575,6 +2601,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2596,6 +2623,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2636,6 +2664,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2722,6 +2751,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2736,6 +2766,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2762,6 +2793,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object BankAccount: properties: bankAccountNumber: @@ -2810,12 +2842,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2859,8 +2890,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2871,6 +2900,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -2943,6 +2973,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3023,6 +3054,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3109,6 +3141,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3173,10 +3206,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3185,6 +3217,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3226,6 +3259,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3261,6 +3295,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3272,6 +3307,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3315,6 +3351,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3332,6 +3369,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3345,6 +3383,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -3359,6 +3398,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3421,6 +3461,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3432,6 +3473,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3509,6 +3551,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3538,6 +3581,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3549,6 +3593,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3643,7 +3688,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -3921,6 +3966,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -4004,7 +4050,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4270,6 +4316,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4353,7 +4400,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4618,6 +4665,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4738,6 +4786,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4775,6 +4824,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -4861,6 +4911,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -4882,6 +4933,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -4913,6 +4965,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -4967,6 +5020,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5411,6 +5465,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5462,6 +5517,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5475,6 +5531,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5484,6 +5541,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5512,6 +5570,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5526,6 +5585,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5552,6 +5612,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5564,6 +5625,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5611,6 +5673,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5628,6 +5691,7 @@ components: type: integer required: - value + type: object TechnicalCancelRequest: properties: additionalData: @@ -5702,6 +5766,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -5863,6 +5928,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -5902,6 +5968,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -5914,11 +5981,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -5975,6 +6044,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6060,6 +6130,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index e7aaf47..730d56a 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v51/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:09Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -701,7 +701,7 @@ paths: operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 - x-methodName: getThe3dsAuthenticationResult + x-methodName: getAuthenticationResult security: - BasicAuth: [] - ApiKeyAuth: [] @@ -788,7 +788,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -860,7 +860,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -935,7 +935,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1016,7 +1016,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1256,6 +1256,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1317,6 +1318,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1598,6 +1600,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1761,6 +1764,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1780,6 +1784,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1820,6 +1831,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1921,6 +1936,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2081,6 +2097,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2204,12 +2221,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2301,6 +2320,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2312,6 +2332,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2340,6 +2361,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2373,6 +2395,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2451,6 +2474,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2510,6 +2534,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2587,6 +2612,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2644,6 +2670,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2665,6 +2692,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2705,6 +2733,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2791,6 +2820,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2805,6 +2835,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2831,6 +2862,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationResultRequest: properties: merchantAccount: @@ -2843,6 +2875,7 @@ components: required: - merchantAccount - pspReference + type: object AuthenticationResultResponse: properties: threeDS1Result: @@ -2851,6 +2884,7 @@ components: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object BankAccount: properties: bankAccountNumber: @@ -2899,12 +2933,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2948,8 +2981,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2960,6 +2991,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -3032,6 +3064,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3112,6 +3145,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3198,6 +3232,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3262,10 +3297,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3274,6 +3308,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3315,6 +3350,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3350,6 +3386,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3361,6 +3398,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3404,6 +3442,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3421,6 +3460,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3434,6 +3474,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -3448,6 +3489,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3510,6 +3552,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3521,6 +3564,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3598,6 +3642,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3627,6 +3672,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3638,6 +3684,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3732,7 +3779,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4016,6 +4063,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -4099,7 +4147,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4371,6 +4419,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4454,7 +4503,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4725,6 +4774,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4845,6 +4895,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4882,6 +4933,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -4968,6 +5020,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -4989,6 +5042,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5020,6 +5074,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -5074,6 +5129,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5518,6 +5574,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5569,6 +5626,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5582,6 +5640,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5591,6 +5650,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5619,6 +5679,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5633,6 +5694,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5659,6 +5721,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5671,6 +5734,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5718,6 +5782,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5735,6 +5800,7 @@ components: type: integer required: - value + type: object TechnicalCancelRequest: properties: additionalData: @@ -5809,6 +5875,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS1Result: properties: cavv: @@ -5830,6 +5897,7 @@ components: description: A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -5991,6 +6059,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -6030,6 +6099,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -6042,11 +6112,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -6103,6 +6175,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6188,6 +6261,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 3bb08c1..e25c55d 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v52/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:09Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -701,7 +701,7 @@ paths: operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 - x-methodName: getThe3dsAuthenticationResult + x-methodName: getAuthenticationResult security: - BasicAuth: [] - ApiKeyAuth: [] @@ -788,7 +788,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -860,7 +860,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -935,7 +935,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1016,7 +1016,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1256,6 +1256,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1317,6 +1318,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1598,6 +1600,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1761,6 +1764,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1780,6 +1784,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1820,6 +1831,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1921,6 +1936,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2081,6 +2097,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2204,12 +2221,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2301,6 +2320,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2312,6 +2332,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2340,6 +2361,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2373,6 +2395,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2451,6 +2474,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2510,6 +2534,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2587,6 +2612,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2644,6 +2670,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2665,6 +2692,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2705,6 +2733,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2791,6 +2820,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2805,6 +2835,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2831,6 +2862,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationResultRequest: properties: merchantAccount: @@ -2843,6 +2875,7 @@ components: required: - merchantAccount - pspReference + type: object AuthenticationResultResponse: properties: threeDS1Result: @@ -2851,6 +2884,7 @@ components: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object BankAccount: properties: bankAccountNumber: @@ -2899,12 +2933,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2948,8 +2981,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2960,6 +2991,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -3032,6 +3064,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3112,6 +3145,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3198,6 +3232,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3262,10 +3297,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3274,6 +3308,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3315,6 +3350,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3350,6 +3386,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3361,6 +3398,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3404,6 +3442,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3421,6 +3460,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3434,6 +3474,7 @@ components: type: array required: - accountScore + type: object Installments: properties: value: @@ -3448,6 +3489,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3510,6 +3552,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3521,6 +3564,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3598,6 +3642,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3627,6 +3672,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3638,6 +3684,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3732,7 +3779,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4024,6 +4071,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -4107,7 +4155,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4379,6 +4427,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4462,7 +4511,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4733,6 +4782,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4853,6 +4903,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4890,6 +4941,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -4976,6 +5028,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -4997,6 +5050,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5028,6 +5082,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -5082,6 +5137,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5526,6 +5582,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5577,6 +5634,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5590,6 +5648,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5599,6 +5658,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5627,6 +5687,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5641,6 +5702,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5667,6 +5729,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5679,6 +5742,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5726,6 +5790,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5743,6 +5808,7 @@ components: type: integer required: - value + type: object TechnicalCancelRequest: properties: additionalData: @@ -5817,6 +5883,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS1Result: properties: cavv: @@ -5838,6 +5905,7 @@ components: description: A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -5999,6 +6067,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -6038,6 +6107,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -6050,11 +6120,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -6111,6 +6183,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6196,6 +6269,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index 9f6dcba..1fd1e6d 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v64/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:05Z' + x-timestamp: '2023-02-20T18:23:10Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -701,7 +701,7 @@ paths: operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 - x-methodName: getThe3dsAuthenticationResult + x-methodName: getAuthenticationResult security: - BasicAuth: [] - ApiKeyAuth: [] @@ -788,7 +788,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -860,7 +860,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -935,7 +935,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1016,7 +1016,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1256,6 +1256,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1317,6 +1318,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1598,6 +1600,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1761,6 +1764,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1780,6 +1784,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1820,6 +1831,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1921,6 +1936,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2081,6 +2097,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2204,12 +2221,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2301,6 +2320,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2312,6 +2332,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2340,6 +2361,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2373,6 +2395,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2451,6 +2474,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2510,6 +2534,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2587,6 +2612,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2644,6 +2670,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2665,6 +2692,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2705,6 +2733,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2791,6 +2820,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2805,6 +2835,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2831,6 +2862,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationResultRequest: properties: merchantAccount: @@ -2843,6 +2875,7 @@ components: required: - merchantAccount - pspReference + type: object AuthenticationResultResponse: properties: threeDS1Result: @@ -2851,6 +2884,7 @@ components: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object BankAccount: properties: bankAccountNumber: @@ -2899,12 +2933,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2948,8 +2981,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2960,6 +2991,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -3032,6 +3064,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3112,6 +3145,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3198,6 +3232,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3262,10 +3297,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3274,6 +3308,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3315,6 +3350,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3350,6 +3386,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3361,6 +3398,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3404,6 +3442,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3421,6 +3460,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3434,6 +3474,7 @@ components: type: array required: - accountScore + type: object FundDestination: properties: additionalData: @@ -3479,6 +3520,7 @@ components: telephoneNumber: description: the telephone number of the person type: string + type: object FundSource: properties: additionalData: @@ -3506,6 +3548,7 @@ components: telephoneNumber: description: Phone number of the person type: string + type: object Installments: properties: plan: @@ -3534,6 +3577,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3596,6 +3640,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3607,6 +3652,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3684,6 +3730,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3713,6 +3760,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3724,6 +3772,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3818,7 +3867,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4118,6 +4167,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -4201,7 +4251,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4473,6 +4523,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4556,7 +4607,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4827,6 +4878,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4947,6 +4999,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4984,6 +5037,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -5070,6 +5124,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -5091,6 +5146,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5122,6 +5178,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -5176,6 +5233,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5620,6 +5678,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5671,6 +5730,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5684,6 +5744,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5693,6 +5754,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5721,6 +5783,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5735,6 +5798,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5761,6 +5825,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5773,6 +5838,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5820,6 +5886,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5837,6 +5904,7 @@ components: type: integer required: - value + type: object SubMerchant: properties: city: @@ -5871,6 +5939,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object TechnicalCancelRequest: properties: additionalData: @@ -5945,6 +6014,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS1Result: properties: cavv: @@ -5966,6 +6036,7 @@ components: description: A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -6127,6 +6198,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -6166,6 +6238,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -6178,11 +6251,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -6239,6 +6314,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6324,6 +6400,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml index ba2b573..e0eefae 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v67/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:06Z' + x-timestamp: '2023-02-20T18:23:10Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -701,7 +701,7 @@ paths: operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 - x-methodName: getThe3dsAuthenticationResult + x-methodName: getAuthenticationResult security: - BasicAuth: [] - ApiKeyAuth: [] @@ -788,7 +788,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -860,7 +860,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -935,7 +935,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1016,7 +1016,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1256,6 +1256,7 @@ components: workPhone: description: Shopper's work phone number (including the country code). type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1317,6 +1318,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1598,6 +1600,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1761,6 +1764,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1780,6 +1784,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1820,6 +1831,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -1921,6 +1936,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2081,6 +2097,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2204,12 +2221,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2301,6 +2320,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2312,6 +2332,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2340,6 +2361,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2373,6 +2395,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2451,6 +2474,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2510,6 +2534,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2587,6 +2612,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2644,6 +2670,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2665,6 +2692,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2705,6 +2733,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2791,6 +2820,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2805,6 +2835,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2831,6 +2862,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationResultRequest: properties: merchantAccount: @@ -2843,6 +2875,7 @@ components: required: - merchantAccount - pspReference + type: object AuthenticationResultResponse: properties: threeDS1Result: @@ -2851,6 +2884,7 @@ components: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object BankAccount: properties: bankAccountNumber: @@ -2899,12 +2933,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -2948,8 +2981,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -2960,6 +2991,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -3032,6 +3064,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3112,6 +3145,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3198,6 +3232,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3262,10 +3297,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3274,6 +3308,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3315,6 +3350,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3350,6 +3386,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3361,6 +3398,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3404,6 +3442,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3421,6 +3460,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3434,6 +3474,7 @@ components: type: array required: - accountScore + type: object FundDestination: properties: additionalData: @@ -3479,6 +3520,7 @@ components: telephoneNumber: description: the telephone number of the person type: string + type: object FundSource: properties: additionalData: @@ -3506,6 +3548,7 @@ components: telephoneNumber: description: Phone number of the person type: string + type: object Installments: properties: plan: @@ -3534,6 +3577,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3596,6 +3640,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3607,6 +3652,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3684,6 +3730,7 @@ components: description: Indicator for whether the shopper has already purchased the same items in the past. type: boolean + type: object ModificationResult: properties: additionalData: @@ -3713,6 +3760,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3724,6 +3772,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3818,7 +3867,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4112,6 +4161,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -4195,7 +4245,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4461,6 +4511,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4544,7 +4595,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4809,6 +4860,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -4929,6 +4981,7 @@ components: - Refused - Success type: string + type: object Recurring: properties: contract: @@ -4966,6 +5019,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -5052,6 +5106,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -5073,6 +5128,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5104,6 +5160,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -5158,6 +5215,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5595,6 +5653,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5646,6 +5705,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5659,6 +5719,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5668,6 +5729,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5696,6 +5758,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5710,6 +5773,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5736,6 +5800,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5748,6 +5813,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5795,6 +5861,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5812,6 +5879,7 @@ components: type: integer required: - value + type: object SubMerchant: properties: city: @@ -5846,6 +5914,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object TechnicalCancelRequest: properties: additionalData: @@ -5920,6 +5989,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS1Result: properties: cavv: @@ -5941,6 +6011,7 @@ components: description: A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding. type: string + type: object ThreeDS2RequestData: properties: acquirerBIN: @@ -6102,6 +6173,7 @@ components: type: string required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -6204,6 +6276,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -6216,11 +6289,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSecureData: properties: authenticationResponse: @@ -6301,6 +6376,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6386,6 +6462,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml index bbc3b38..6a68c76 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -25,7 +25,7 @@ info: \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**." - x-timestamp: '2022-12-13T09:27:06Z' + x-timestamp: '2023-02-21T16:26:41Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -64,7 +64,7 @@ paths: operationId: post-adjustAuthorisation x-groupName: Modifications x-sortIndex: 6 - x-methodName: changeTheAuthorisedAmount + x-methodName: adjustAuthorisation security: - BasicAuth: [] - ApiKeyAuth: [] @@ -142,7 +142,7 @@ paths: operationId: post-authorise x-groupName: General x-sortIndex: 1 - x-methodName: createAuthorisation + x-methodName: authorise security: - BasicAuth: [] - ApiKeyAuth: [] @@ -229,7 +229,7 @@ paths: operationId: post-authorise3d x-groupName: General x-sortIndex: 2 - x-methodName: complete3dsAuthorisation + x-methodName: authorise3d security: - BasicAuth: [] - ApiKeyAuth: [] @@ -305,7 +305,7 @@ paths: operationId: post-authorise3ds2 x-groupName: General x-sortIndex: 3 - x-methodName: complete3ds2Authorisation + x-methodName: authorise3ds2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -383,7 +383,7 @@ paths: operationId: post-cancel x-groupName: Modifications x-sortIndex: 2 - x-methodName: cancelAuthorisation + x-methodName: cancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -462,7 +462,7 @@ paths: operationId: post-cancelOrRefund x-groupName: Modifications x-sortIndex: 4 - x-methodName: cancelOrRefundPayment + x-methodName: cancelOrRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -553,7 +553,7 @@ paths: operationId: post-capture x-groupName: Modifications x-sortIndex: 1 - x-methodName: captureAuthorisation + x-methodName: capture security: - BasicAuth: [] - ApiKeyAuth: [] @@ -632,7 +632,7 @@ paths: operationId: post-donate x-groupName: Modifications x-sortIndex: 6 - x-methodName: createDonation + x-methodName: donate security: - BasicAuth: [] - ApiKeyAuth: [] @@ -701,7 +701,7 @@ paths: operationId: post-getAuthenticationResult x-groupName: General x-sortIndex: 4 - x-methodName: getThe3dsAuthenticationResult + x-methodName: getAuthenticationResult security: - BasicAuth: [] - ApiKeyAuth: [] @@ -788,7 +788,7 @@ paths: operationId: post-refund x-groupName: Modifications x-sortIndex: 3 - x-methodName: refundCapturedPayment + x-methodName: refund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -860,7 +860,7 @@ paths: operationId: post-retrieve3ds2Result x-groupName: General x-sortIndex: 4 - x-methodName: getThe3ds2AuthenticationResult + x-methodName: retrieve3ds2Result security: - BasicAuth: [] - ApiKeyAuth: [] @@ -935,7 +935,7 @@ paths: operationId: post-technicalCancel x-groupName: Modifications x-sortIndex: 5 - x-methodName: cancelAuthorisationUsingYourReference + x-methodName: technicalCancel security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1016,7 +1016,7 @@ paths: operationId: post-voidPendingRefund x-groupName: Modifications x-sortIndex: 7 - x-methodName: cancelInpersonRefund + x-methodName: voidPendingRefund security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1265,6 +1265,7 @@ components: x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. description: Shopper's work phone number (including the country code). type: string + type: object AcctInfo: properties: chAccAgeInd: @@ -1403,6 +1404,7 @@ components: in the previous year. Max length: 3 characters.' maxLength: 3 type: string + type: object AdditionalData3DSecure: properties: allow3DS2: @@ -1464,6 +1466,7 @@ components: \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ \ the BIN is not enrolled, you will receive an error.\n\n" type: string + type: object AdditionalDataAirline: properties: airline.agency_invoice_number: @@ -1745,6 +1748,7 @@ components: type: string required: - airline.passenger_name + type: object AdditionalDataCarRental: properties: carRental.checkOutDate: @@ -1908,6 +1912,7 @@ components: * maxLength: 1' type: string + type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: @@ -1927,6 +1932,13 @@ components: \ the same idempotency key not be processed beyond returning the stored\ \ response." type: string + allowPartialAuth: + description: "Set to true to authorise a part of the requested amount in\ + \ case the cardholder does not have enough funds on their account. \n\ + If a payment was partially authorised, the response includes resultCode:\ + \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ + To enable this functionality, contact our Support Team." + type: string authorisationType: description: "Flags a card payment request for either pre-authorisation\ \ or final authorisation. For more information, refer to [Authorisation\ @@ -1967,6 +1979,10 @@ components: - NoShow - DelayedCharge type: string + manualCapture: + description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) + for the transaction. + type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based @@ -2068,6 +2084,7 @@ components: * Fixed length: 11 or 14 characters.' type: string + type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: @@ -2228,6 +2245,7 @@ components: > Required for Level 2 and Level 3 data.' type: string + type: object AdditionalDataLodging: properties: lodging.checkInDate: @@ -2351,12 +2369,14 @@ components: * maxLength: 1' type: string + type: object AdditionalDataModifications: properties: installmentPaymentData.selectedInstallmentOption: description: This is the installment option selected by the shopper. It is required only if specified by the user. type: string + type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: @@ -2448,6 +2468,7 @@ components: openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string + type: object AdditionalDataOpi: properties: opi.includeTransToken: @@ -2459,6 +2480,7 @@ components: You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: @@ -2487,6 +2509,7 @@ components: description: Identification name or number for the invoice, defined by the merchant. type: string + type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: @@ -2520,6 +2543,7 @@ components: and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string + type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: @@ -2598,6 +2622,7 @@ components: checks for the payment request are skipped and the transaction will not get a risk score. type: string + type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2657,6 +2682,7 @@ components: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string + type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: @@ -2734,6 +2760,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: @@ -2791,6 +2818,7 @@ components: * maxLength: 12' type: string + type: object AdditionalDataWallets: properties: androidpay.token: @@ -2812,6 +2840,7 @@ components: visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string + type: object Address: properties: city: @@ -2852,6 +2881,7 @@ components: - city - postalCode - country + type: object AdjustAuthorisationRequest: properties: additionalData: @@ -2910,6 +2940,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -2938,6 +2972,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Amount: properties: currency: @@ -2952,6 +2987,7 @@ components: required: - value - currency + type: object ApplicationInfo: properties: adyenLibrary: @@ -2978,6 +3014,7 @@ components: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' + type: object AuthenticationResultRequest: properties: merchantAccount: @@ -2990,6 +3027,7 @@ components: required: - merchantAccount - pspReference + type: object AuthenticationResultResponse: properties: threeDS1Result: @@ -2998,6 +3036,7 @@ components: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object BankAccount: properties: bankAccountNumber: @@ -3046,12 +3085,11 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string + type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string colorDepth: x-addedInVersion: '40' @@ -3095,8 +3133,6 @@ components: type: integer userAgent: description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 type: string required: - userAgent @@ -3107,6 +3143,7 @@ components: - screenWidth - timeZoneOffset - language + type: object CancelOrRefundRequest: properties: additionalData: @@ -3160,6 +3197,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -3179,6 +3220,7 @@ components: required: - merchantAccount - originalReference + type: object CancelRequest: properties: additionalData: @@ -3232,6 +3274,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -3259,6 +3305,7 @@ components: required: - merchantAccount - originalReference + type: object CaptureRequest: properties: additionalData: @@ -3317,6 +3364,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -3345,6 +3396,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object Card: properties: cvc: @@ -3409,10 +3461,9 @@ components: minLength: 4 type: string required: - - number - - expiryMonth - expiryYear - holderName + type: object CommonField: properties: name: @@ -3421,6 +3472,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object DeviceRenderOptions: properties: sdkInterface: @@ -3462,6 +3514,7 @@ components: - text type: string type: array + type: object DonationRequest: properties: donationAccount: @@ -3487,6 +3540,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -3497,6 +3554,7 @@ components: - merchantAccount - donationAccount - modificationAmount + type: object ExternalPlatform: properties: integrator: @@ -3508,6 +3566,7 @@ components: version: description: Version of the field. For example, Version of External Platform. type: string + type: object ForexQuote: properties: account: @@ -3551,6 +3610,7 @@ components: required: - validTill - basePoints + type: object FraudCheckResult: properties: accountScore: @@ -3568,6 +3628,7 @@ components: - checkId - name - accountScore + type: object FraudResult: properties: accountScore: @@ -3581,6 +3642,7 @@ components: type: array required: - accountScore + type: object FundDestination: properties: additionalData: @@ -3626,6 +3688,7 @@ components: telephoneNumber: description: the telephone number of the person type: string + type: object FundSource: properties: additionalData: @@ -3653,6 +3716,7 @@ components: telephoneNumber: description: Phone number of the person type: string + type: object Installments: properties: plan: @@ -3681,6 +3745,7 @@ components: type: integer required: - value + type: object Mandate: properties: amount: @@ -3743,6 +3808,7 @@ components: - frequency - amount - endsAt + type: object MerchantDevice: properties: os: @@ -3754,6 +3820,7 @@ components: reference: description: Merchant device reference. type: string + type: object MerchantRiskIndicator: properties: addressMatch: @@ -3860,6 +3927,7 @@ components: x-addedInVersion: '68' description: Indicates shipping method chosen for the transaction. type: string + type: object ModificationResult: properties: additionalData: @@ -3889,6 +3957,7 @@ components: required: - response - pspReference + type: object Name: properties: firstName: @@ -3900,6 +3969,7 @@ components: required: - firstName - lastName + type: object PaymentRequest: properties: accountInfo: @@ -3994,7 +4064,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4052,6 +4122,27 @@ components: description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' + localizedShopperStatement: + x-addedInVersion: '68' + additionalProperties: + type: string + description: "This field allows merchants to use dynamic shopper statement\ + \ in local character sets.\nThe local shopper statement field can be supplied\ + \ in markets where localized merchant descriptors are used. Currently,\ + \ Adyen only supports this in the Japanese market\n.The available character\ + \ sets at the moment are:\n* Processing in Japan: **ja-Kana**\nThe character\ + \ set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special\ + \ characters.\nMerchants should send the Katakana shopperStatement in\ + \ full-width characters. \nAn example request would be:\n> {\n \"shopperStatement\"\ + \ : \"ADYEN - SELLER-A\",\n \"localizedShopperStatement\" : {\n \"\ + ja-Kana\" : \"ADYEN - \u30BB\u30E9\u30FCA\"\n }\n}\nWe recommend merchants\ + \ to always supply the field localizedShopperStatement in addition to\ + \ the field shopperStatement.It is issuer dependent whether the localized\ + \ shopper statement field is supported.\nIn the case of non-domestic transactions\ + \ (e.g. US-issued cards processed in JP) the field `shopperStatement`\ + \ is used to modify the statement of the shopper.\nAdyen handles the complexity\ + \ of ensuring the correct descriptors are assigned." + type: object mandate: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' @@ -4118,6 +4209,10 @@ components: payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' recurring: description: The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). @@ -4288,6 +4383,7 @@ components: - merchantAccount - reference - amount + type: object PaymentRequest3d: properties: accountInfo: @@ -4371,7 +4467,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4406,6 +4502,27 @@ components: description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' + localizedShopperStatement: + x-addedInVersion: '68' + additionalProperties: + type: string + description: "This field allows merchants to use dynamic shopper statement\ + \ in local character sets.\nThe local shopper statement field can be supplied\ + \ in markets where localized merchant descriptors are used. Currently,\ + \ Adyen only supports this in the Japanese market\n.The available character\ + \ sets at the moment are:\n* Processing in Japan: **ja-Kana**\nThe character\ + \ set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special\ + \ characters.\nMerchants should send the Katakana shopperStatement in\ + \ full-width characters. \nAn example request would be:\n> {\n \"shopperStatement\"\ + \ : \"ADYEN - SELLER-A\",\n \"localizedShopperStatement\" : {\n \"\ + ja-Kana\" : \"ADYEN - \u30BB\u30E9\u30FCA\"\n }\n}\nWe recommend merchants\ + \ to always supply the field localizedShopperStatement in addition to\ + \ the field shopperStatement.It is issuer dependent whether the localized\ + \ shopper statement field is supported.\nIn the case of non-domestic transactions\ + \ (e.g. US-issued cards processed in JP) the field `shopperStatement`\ + \ is used to modify the statement of the shopper.\nAdyen handles the complexity\ + \ of ensuring the correct descriptors are assigned." + type: object mcc: x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) @@ -4637,6 +4754,7 @@ components: - merchantAccount - paResponse - md + type: object PaymentRequest3ds2: properties: accountInfo: @@ -4720,7 +4838,7 @@ components: Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' - format: date-time + format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. @@ -4755,6 +4873,27 @@ components: description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' + localizedShopperStatement: + x-addedInVersion: '68' + additionalProperties: + type: string + description: "This field allows merchants to use dynamic shopper statement\ + \ in local character sets.\nThe local shopper statement field can be supplied\ + \ in markets where localized merchant descriptors are used. Currently,\ + \ Adyen only supports this in the Japanese market\n.The available character\ + \ sets at the moment are:\n* Processing in Japan: **ja-Kana**\nThe character\ + \ set **ja-Kana** supports UTF-8 based Katakana and alphanumeric and special\ + \ characters.\nMerchants should send the Katakana shopperStatement in\ + \ full-width characters. \nAn example request would be:\n> {\n \"shopperStatement\"\ + \ : \"ADYEN - SELLER-A\",\n \"localizedShopperStatement\" : {\n \"\ + ja-Kana\" : \"ADYEN - \u30BB\u30E9\u30FCA\"\n }\n}\nWe recommend merchants\ + \ to always supply the field localizedShopperStatement in addition to\ + \ the field shopperStatement.It is issuer dependent whether the localized\ + \ shopper statement field is supported.\nIn the case of non-domestic transactions\ + \ (e.g. US-issued cards processed in JP) the field `shopperStatement`\ + \ is used to modify the statement of the shopper.\nAdyen handles the complexity\ + \ of ensuring the correct descriptors are assigned." + type: object mcc: x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) @@ -4985,6 +5124,7 @@ components: - merchantAccount - reference - amount + type: object PaymentResult: properties: additionalData: @@ -5105,6 +5245,7 @@ components: - Refused - Success type: string + type: object Phone: properties: cc: @@ -5116,6 +5257,20 @@ components: description: 'Subscriber number. Maximum length: 15 characters.' maxLength: 15 type: string + type: object + PlatformChargebackLogic: + properties: + behavior: + x-addedInVersion: '68' + enum: + - deductAccordingToSplitRatio + - deductFromLiableAccount + - deductFromOneBalanceAccount + type: string + targetAccount: + x-addedInVersion: '68' + type: string + type: object Recurring: properties: contract: @@ -5153,6 +5308,7 @@ components: - VISATOKENSERVICE - MCTOKENSERVICE type: string + type: object RefundRequest: properties: additionalData: @@ -5211,6 +5367,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -5239,6 +5399,7 @@ components: - merchantAccount - modificationAmount - originalReference + type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: @@ -5260,6 +5421,7 @@ components: threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean + type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: @@ -5291,6 +5453,7 @@ components: billingAddress.street: description: The billing address street passed in the payment request. type: string + type: object ResponseAdditionalDataCard: properties: cardBin: @@ -5345,6 +5508,7 @@ components: Example: 52123423' type: string + type: object ResponseAdditionalDataCommon: properties: acquirerAccountCode: @@ -5782,6 +5946,7 @@ components: Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' type: string + type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: @@ -5833,6 +5998,7 @@ components: > Only relevant for card payments in countries that support installments.' type: string + type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: @@ -5846,6 +6012,7 @@ components: networkToken.tokenSummary: description: The last four digits of a network token. type: string + type: object ResponseAdditionalDataOpi: properties: opi.transToken: @@ -5855,6 +6022,7 @@ components: tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string + type: object ResponseAdditionalDataSepa: properties: sepadirectdebit.dateOfSignature: @@ -5883,6 +6051,7 @@ components: Example: OOFF' type: string + type: object SDKEphemPubKey: properties: crv: @@ -5897,6 +6066,7 @@ components: y: description: The `y` value as received from the 3D Secure 2 SDK. type: string + type: object ServiceError: properties: additionalData: @@ -5923,6 +6093,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object ShopperInteractionDevice: properties: locale: @@ -5935,6 +6106,7 @@ components: description: Version of the operating system on the shopper interaction device. type: string + type: object Split: properties: account: @@ -5982,6 +6154,7 @@ components: required: - amount - type + type: object SplitAmount: properties: currency: @@ -5999,6 +6172,7 @@ components: type: integer required: - value + type: object SubMerchant: properties: city: @@ -6033,6 +6207,7 @@ components: * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string + type: object TechnicalCancelRequest: properties: additionalData: @@ -6080,6 +6255,10 @@ components: x-addedInVersion: '30' description: The original merchant reference to cancel. type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -6107,6 +6286,7 @@ components: required: - merchantAccount - originalMerchantReference + type: object ThreeDS1Result: properties: cavv: @@ -6128,6 +6308,7 @@ components: description: A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding. type: string + type: object ThreeDS2RequestData: properties: acctInfo: @@ -6420,6 +6601,7 @@ components: $ref: '#/components/schemas/Phone' required: - deviceChannel + type: object ThreeDS2Result: properties: authenticationValue: @@ -6522,6 +6704,7 @@ components: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string + type: object ThreeDS2ResultRequest: properties: merchantAccount: @@ -6534,11 +6717,13 @@ components: required: - merchantAccount - pspReference + type: object ThreeDS2ResultResponse: properties: threeDS2Result: description: The result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' + type: object ThreeDSRequestorAuthenticationInfo: properties: threeDSReqAuthData: @@ -6573,6 +6758,7 @@ components: maxLength: 12 minLength: 12 type: string + type: object ThreeDSRequestorPriorAuthenticationInfo: properties: threeDSReqPriorAuthData: @@ -6608,6 +6794,7 @@ components: maxLength: 36 minLength: 36 type: string + type: object ThreeDSecureData: properties: authenticationResponse: @@ -6694,6 +6881,7 @@ components: 20 bytes in a decoded form). format: byte type: string + type: object VoidPendingRefundRequest: properties: additionalData: @@ -6753,6 +6941,10 @@ components: ' type: string + platformChargebackLogic: + x-addedInVersion: '68' + description: Defines the behavior to be applied in case of a chargeback. + $ref: '#/components/schemas/PlatformChargebackLogic' reference: description: 'Your reference for the payment modification. This reference is visible in Customer Area and in reports. @@ -6779,6 +6971,7 @@ components: type: string required: - merchantAccount + type: object securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/StoredValueService-v46.yaml b/yaml/StoredValueService-v46.yaml index 5e33504..f4170e9 100644 --- a/yaml/StoredValueService-v46.yaml +++ b/yaml/StoredValueService-v46.yaml @@ -6,7 +6,7 @@ info: x-publicVersion: true title: Adyen Stored Value API description: A set of API endpoints to manage stored value products. - x-timestamp: '2023-02-09T20:21:26Z' + x-timestamp: '2023-02-20T18:23:08Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -27,7 +27,7 @@ paths: operationId: post-changeStatus x-groupName: General x-sortIndex: 0 - x-methodName: changesStatusOfPaymentMethod + x-methodName: changeStatus security: - BasicAuth: [] - ApiKeyAuth: [] @@ -76,7 +76,7 @@ paths: operationId: post-checkBalance x-groupName: General x-sortIndex: 0 - x-methodName: checksBalance + x-methodName: checkBalance security: - BasicAuth: [] - ApiKeyAuth: [] @@ -125,7 +125,7 @@ paths: operationId: post-issue x-groupName: General x-sortIndex: 0 - x-methodName: issuesNewCard + x-methodName: issue security: - BasicAuth: [] - ApiKeyAuth: [] @@ -174,7 +174,7 @@ paths: operationId: post-load x-groupName: General x-sortIndex: 0 - x-methodName: loadsPaymentMethod + x-methodName: load security: - BasicAuth: [] - ApiKeyAuth: [] @@ -224,7 +224,7 @@ paths: operationId: post-mergeBalance x-groupName: General x-sortIndex: 0 - x-methodName: mergeBalanceOfTwoCards + x-methodName: mergeBalance security: - BasicAuth: [] - ApiKeyAuth: [] @@ -273,7 +273,7 @@ paths: operationId: post-voidTransaction x-groupName: General x-sortIndex: 0 - x-methodName: voidsTransaction + x-methodName: voidTransaction security: - BasicAuth: [] - ApiKeyAuth: [] @@ -329,6 +329,7 @@ components: required: - value - currency + type: object ServiceError: properties: additionalData: @@ -355,6 +356,7 @@ components: description: The HTTP response status. format: int32 type: integer + type: object StoredValueBalanceCheckRequest: properties: amount: @@ -423,6 +425,7 @@ components: - merchantAccount - reference - paymentMethod + type: object StoredValueBalanceCheckResponse: properties: currentBalance: @@ -458,6 +461,7 @@ components: thirdPartyRefusalReason: description: Raw refusal reason received from the third party, where available type: string + type: object StoredValueBalanceMergeRequest: properties: amount: @@ -534,6 +538,7 @@ components: - reference - paymentMethod - sourcePaymentMethod + type: object StoredValueBalanceMergeResponse: properties: authCode: @@ -577,6 +582,7 @@ components: thirdPartyRefusalReason: description: Raw refusal reason received from the third party, where available type: string + type: object StoredValueIssueRequest: properties: amount: @@ -645,6 +651,7 @@ components: - merchantAccount - reference - paymentMethod + type: object StoredValueIssueResponse: properties: authCode: @@ -694,6 +701,7 @@ components: thirdPartyRefusalReason: description: Raw refusal reason received from the third party, where available type: string + type: object StoredValueLoadRequest: properties: amount: @@ -770,6 +778,7 @@ components: - reference - paymentMethod - amount + type: object StoredValueLoadResponse: properties: authCode: @@ -813,6 +822,7 @@ components: thirdPartyRefusalReason: description: Raw refusal reason received from the third party, where available type: string + type: object StoredValueStatusChangeRequest: properties: amount: @@ -888,6 +898,7 @@ components: - reference - paymentMethod - status + type: object StoredValueStatusChangeResponse: properties: authCode: @@ -931,6 +942,7 @@ components: thirdPartyRefusalReason: description: Raw refusal reason received from the third party, where available type: string + type: object StoredValueVoidRequest: properties: merchantAccount: @@ -960,6 +972,7 @@ components: required: - merchantAccount - originalReference + type: object StoredValueVoidResponse: properties: currentBalance: @@ -995,6 +1008,7 @@ components: thirdPartyRefusalReason: description: Raw refusal reason received from the third party, where available type: string + type: object securitySchemes: ApiKeyAuth: in: header