From 8fa38dc4cc7f34db9009f6fd7c74c28d7661ff7c Mon Sep 17 00:00:00 2001 From: aleksei Date: Sat, 7 Aug 2021 13:34:00 +0200 Subject: [PATCH] Updated JSON specs --- json/AccountService-v3.json | 530 +- json/AccountService-v4.json | 337 +- json/AccountService-v5.json | 474 +- json/AccountService-v6.json | 477 +- ...BalancePlatformNotificationService-v1.json | 1724 +++++ json/BalancePlatformService-v1.json | 1171 +-- json/BinLookupService-v40.json | 124 +- json/BinLookupService-v50.json | 128 +- json/CheckoutService-v37.json | 4424 +----------- json/CheckoutService-v40.json | 4592 ++---------- json/CheckoutService-v41.json | 4617 ++---------- json/CheckoutService-v46.json | 4619 ++---------- json/CheckoutService-v49.json | 4767 ++---------- json/CheckoutService-v50.json | 4813 ++---------- json/CheckoutService-v51.json | 4850 ++----------- json/CheckoutService-v52.json | 4854 ++----------- json/CheckoutService-v53.json | 4860 ++----------- json/CheckoutService-v64.json | 4890 ++----------- json/CheckoutService-v65.json | 4906 ++----------- json/CheckoutService-v66.json | 4910 ++----------- json/CheckoutService-v67.json | 6420 +++++------------ json/FundService-v3.json | 33 +- json/FundService-v5.json | 59 +- json/FundService-v6.json | 59 +- json/HopService-v1.json | 28 +- json/HopService-v5.json | 24 +- json/HopService-v6.json | 24 +- json/MarketPayNotificationService-v3.json | 148 +- json/MarketPayNotificationService-v4.json | 206 +- json/MarketPayNotificationService-v5.json | 330 +- json/MarketPayNotificationService-v6.json | 352 +- json/NotificationConfigurationService-v1.json | 88 +- json/NotificationConfigurationService-v2.json | 88 +- json/NotificationConfigurationService-v3.json | 88 +- json/NotificationConfigurationService-v4.json | 88 +- json/NotificationConfigurationService-v5.json | 88 +- json/NotificationConfigurationService-v6.json | 88 +- json/PaymentService-v25.json | 436 +- json/PaymentService-v30.json | 516 +- json/PaymentService-v40.json | 711 +- json/PaymentService-v46.json | 727 +- json/PaymentService-v49.json | 741 +- json/PaymentService-v50.json | 755 +- json/PaymentService-v51.json | 788 +- json/PaymentService-v52.json | 790 +- json/PaymentService-v64.json | 792 +- json/PayoutService-v30.json | 328 +- json/PayoutService-v40.json | 370 +- json/PayoutService-v50.json | 390 +- json/PayoutService-v51.json | 392 +- json/PayoutService-v52.json | 398 +- json/PayoutService-v64.json | 400 +- json/RecurringService-v25.json | 69 +- json/RecurringService-v30.json | 69 +- json/RecurringService-v40.json | 73 +- json/RecurringService-v49.json | 75 +- json/TestCardService-v1.json | 15 +- json/Webhooks-v1.json | 3315 +++++++++ 58 files changed, 20025 insertions(+), 62403 deletions(-) create mode 100644 json/BalancePlatformNotificationService-v1.json create mode 100644 json/Webhooks-v1.json diff --git a/json/AccountService-v3.json b/json/AccountService-v3.json index 8f5d421..face1b9 100644 --- a/json/AccountService-v3.json +++ b/json/AccountService-v3.json @@ -25,6 +25,9 @@ "paths" : { "/closeAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Close an account.", "description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments will be directed to your liable account.", "operationId" : "post-closeAccount", @@ -79,8 +82,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -104,8 +107,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -140,6 +143,9 @@ }, "/closeAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Close an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** status,the payments will be directed to your liable account.", "operationId" : "post-closeAccountHolder", @@ -194,8 +200,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -219,8 +225,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -255,6 +261,9 @@ }, "/createAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Create a new account.", "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", @@ -309,8 +318,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -334,8 +343,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -370,6 +379,9 @@ }, "/createAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Create a new account holder.", "description" : "Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", @@ -407,11 +419,11 @@ "content" : { "application/json" : { "examples" : { - "business-200" : { - "$ref" : "#/components/examples/post-createAccountHolder-business-200" + "business" : { + "$ref" : "#/components/examples/post-createAccountHolder-business" }, - "individual-200" : { - "$ref" : "#/components/examples/post-createAccountHolder-individual-200" + "individual" : { + "$ref" : "#/components/examples/post-createAccountHolder-individual" } }, "schema" : { @@ -425,8 +437,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -440,8 +452,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/post-createAccountHolder-generic-401" + "generic" : { + "$ref" : "#/components/examples/post-createAccountHolder-generic" } }, "schema" : { @@ -455,8 +467,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -470,11 +482,11 @@ "content" : { "application/json" : { "examples" : { - "business-422" : { - "$ref" : "#/components/examples/post-createAccountHolder-business-422" + "business" : { + "$ref" : "#/components/examples/post-createAccountHolder-business" }, - "individual-422" : { - "$ref" : "#/components/examples/post-createAccountHolder-individual-422" + "individual" : { + "$ref" : "#/components/examples/post-createAccountHolder-individual" } }, "schema" : { @@ -488,8 +500,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/post-createAccountHolder-generic-500" + "generic" : { + "$ref" : "#/components/examples/post-createAccountHolder-generic" } }, "schema" : { @@ -504,6 +516,9 @@ }, "/deleteBankAccounts" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete bank accounts.", "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", @@ -558,8 +573,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -583,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -619,6 +634,9 @@ }, "/deleteShareholders" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete shareholders.", "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", @@ -673,8 +691,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -698,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -734,6 +752,9 @@ }, "/deleteSignatories" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete signatories.", "description" : "Deletes one or more signatories from an account holder.", "operationId" : "post-deleteSignatories", @@ -783,8 +804,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -808,8 +829,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,6 +865,9 @@ }, "/getAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get an account holder.", "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", @@ -901,8 +925,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -926,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -962,6 +986,9 @@ }, "/getTaxForm" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get a tax form.", "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms).", "operationId" : "post-getTaxForm", @@ -1006,8 +1033,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1031,8 +1058,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1067,6 +1094,9 @@ }, "/getUploadedDocuments" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Get documents.", "description" : "Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).\n", "operationId" : "post-getUploadedDocuments", @@ -1111,8 +1141,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1136,8 +1166,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1172,6 +1202,9 @@ }, "/suspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Suspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", @@ -1226,8 +1259,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1251,8 +1284,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1287,6 +1320,9 @@ }, "/unSuspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Unsuspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** status if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a KYC deadline expires.\n\nYou can only unsuspend account holders if they _do not_ have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", @@ -1341,8 +1377,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1366,8 +1402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1402,6 +1438,9 @@ }, "/updateAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Update an account.", "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", @@ -1456,8 +1495,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1481,8 +1520,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1517,6 +1556,9 @@ }, "/updateAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update an account holder.", "description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the objects below.\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes along with other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation.\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n", "operationId" : "post-updateAccountHolder", @@ -1580,8 +1622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1605,8 +1647,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1641,6 +1683,9 @@ }, "/updateAccountHolderState" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update payout or processing state.", "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", @@ -1695,8 +1740,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1720,8 +1765,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1756,6 +1801,9 @@ }, "/uploadDocument" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Upload a document.", "description" : "Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).", "operationId" : "post-uploadDocument", @@ -1810,8 +1858,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1835,8 +1883,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1958,6 +2006,10 @@ "description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.", "type" : "object" }, + "principalBusinessAddress" : { + "description" : "The principal business address of the account holder.", + "$ref" : "#/components/schemas/ViasAddress" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -2024,7 +2076,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2050,7 +2102,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2190,6 +2242,13 @@ "description" : "The legal name of the company.", "type" : "string" }, + "listedUltimateParentCompany" : { + "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", + "items" : { + "$ref" : "#/components/schemas/UltimateParentCompany" + }, + "type" : "array" + }, "shareholders" : { "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { @@ -2266,7 +2325,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -2304,14 +2363,12 @@ "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" @@ -2338,12 +2395,12 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2363,7 +2420,7 @@ "type" : "boolean" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -2435,7 +2492,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -2516,12 +2573,12 @@ "DocumentDetail" : { "properties" : { "accountHolderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of account holder, to which the document applies.", "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, @@ -2534,8 +2591,6 @@ "enum" : [ "BANK_STATEMENT", "BSN", - "COMPANY_REGISTRATION_SCREENING", - "CONSTITUTIONAL_DOCUMENT", "DRIVING_LICENCE", "DRIVING_LICENCE_BACK", "DRIVING_LICENCE_FRONT", @@ -2543,8 +2598,7 @@ "ID_CARD_BACK", "ID_CARD_FRONT", "PASSPORT", - "SSN", - "SUPPORTING_DOCUMENTS" + "SSN" ], "type" : "string" }, @@ -2553,7 +2607,7 @@ "type" : "string" }, "shareholderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, @@ -2623,7 +2677,6 @@ "currency", "currencyCode", "dateOfBirth", - "description", "destinationAccountCode", "document", "documentExpirationDate", @@ -2645,8 +2698,6 @@ "houseNumberOrName", "iban", "idCard", - "idCardBack", - "idCardFront", "idNumber", "identityDocument", "individualDetails", @@ -2684,13 +2735,13 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", "postalCode", "primaryCurrency", "reason", - "registrationNumber", "returnUrl", "schedule", "shareholder", @@ -2704,6 +2755,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -2787,7 +2839,7 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -2803,9 +2855,7 @@ "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, @@ -2822,7 +2872,7 @@ "type" : "boolean" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -2842,7 +2892,7 @@ "type" : "string" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the Account Holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -2918,7 +2968,7 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of the Bank Account for which to retrieve the documents.", "type" : "string" }, @@ -3338,6 +3388,46 @@ "accountHolderStatus" ] }, + "UltimateParentCompany" : { + "properties" : { + "address" : { + "description" : "Address of the ultimate parent company.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "businessDetails" : { + "description" : "Details about the ultimate parent company's business.", + "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" + }, + "ultimateParentCompanyCode" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", + "type" : "string" + } + } + }, + "UltimateParentCompanyBusinessDetails" : { + "properties" : { + "legalBusinessName" : { + "description" : "The legal name of the company.", + "type" : "string" + }, + "registrationNumber" : { + "description" : "The registration number of the company.", + "type" : "string" + }, + "stockExchange" : { + "description" : "Market Identifier Code (MIC).", + "type" : "string" + }, + "stockNumber" : { + "description" : "International Securities Identification Number (ISIN).", + "type" : "string" + }, + "stockTicker" : { + "description" : "Stock Ticker symbol.", + "type" : "string" + } + } + }, "UnSuspendAccountHolderRequest" : { "properties" : { "accountHolderCode" : { @@ -3383,7 +3473,7 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier to which the Account Holder should be updated.\n>The processing tier can not be lowered through this request.\n\n>Required if accountHolderDetails are not provided.", "format" : "int32", "type" : "integer" @@ -3404,12 +3494,12 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3436,7 +3526,7 @@ "type" : "array" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -3664,7 +3754,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" @@ -3723,16 +3813,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad Request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: I", - "errorType" : "validation" - } - }, - "generic-403" : { + "generic" : { "summary" : "Response code 401. Forbidden.", "value" : { "status" : 403, @@ -3760,109 +3841,6 @@ } }, "post-createAccountHolder-business" : { - "summary" : "Create a business account holder", - "value" : { - "accountHolderCode" : "GENERATE_CODE", - "accountHolderDetails" : { - "businessDetails" : { - "doingBusinessAs" : "Real Good Restaurant", - "legalBusinessName" : "Real Good Restaurant Inc.", - "shareholders" : [ - { - "ShareholderContact" : { - "name" : { - "firstName" : "John", - "gender" : "MALE", - "lastName" : "Carpenter" - } - } - } - ] - }, - "email" : "test@adyen.com", - "webAddress" : "https://www.your-website.com" - }, - "legalEntity" : "Business" - } - }, - "post-createAccountHolder-business-200" : { - "summary" : "Response code 200. Success.", - "value" : { - "invalidFields" : [ - ], - "pspReference" : "8816080397613514", - "accountCode" : "8816080397613522", - "accountHolderCode" : "GENERATE_CODE", - "accountHolderDetails" : { - "address" : { - "country" : "US" - }, - "bankAccountDetails" : [ - ], - "email" : "tim@green.com", - "individualDetails" : { - "name" : { - "firstName" : "Tim", - "gender" : "MALE", - "lastName" : "Green" - } - }, - "merchantCategoryCode" : "7999", - "payoutMethods" : [ - ], - "webAddress" : null - }, - "accountHolderStatus" : { - "status" : "Active", - "processingState" : { - "disabled" : false, - "processedFrom" : { - "currency" : "USD", - "value" : 0 - }, - "processedTo" : { - "currency" : "USD", - "value" : 9999 - }, - "tierNumber" : 0 - }, - "payoutState" : { - "allowPayout" : false, - "disabled" : false - }, - "events" : [ - ] - }, - "legalEntity" : "Individual", - "verification" : { - "accountHolder" : { - "checks" : [ - { - "type" : "IDENTITY_VERIFICATION", - "status" : "AWAITING_DATA", - "requiredFields" : [ - "AccountHolderDetails.IndividualDetails.PersonalData.personalData", - "AccountHolderDetails.Address.city", - "AccountHolderDetails.Address.houseNumberOrName", - "AccountHolderDetails.Address.postalCode", - "AccountHolderDetails.Address.street", - "AccountHolderDetails.IndividualDetails.PersonalData.idNumber", - "AccountHolderDetails.PhoneNumber.phoneNumber" - ] - }, - { - "type" : "PAYOUT_METHOD_VERIFICATION", - "status" : "AWAITING_DATA", - "requiredFields" : [ - "AccountHolderDetails.BankAccountDetails.bankAccount" - ] - } - ] - } - } - } - }, - "post-createAccountHolder-business-422" : { "summary" : "Response code 422. Unprocessable Entity.", "value" : { "invalidFields" : [ @@ -3878,7 +3856,7 @@ "pspReference" : "8816080407386622" } }, - "post-createAccountHolder-generic-401" : { + "post-createAccountHolder-generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -3887,111 +3865,7 @@ "errorType" : "security" } }, - "post-createAccountHolder-generic-500" : { - "summary" : "Response code 500. Internal Server Error.", - "value" : { - "status" : 500, - "errorCode" : "701", - "message" : "Internal Error in createAccountHolder 991608040809302G", - "errorType" : "internal" - } - }, "post-createAccountHolder-individual" : { - "summary" : "Create an individual account holder", - "value" : { - "accountHolderCode" : "GENERATE_CODE", - "accountHolderDetails" : { - "email" : "tim@green.com", - "individualDetails" : { - "name" : { - "firstName" : "Tim", - "gender" : "MALE", - "lastName" : "Green" - } - }, - "webAddress" : "https://www.your-website.com" - }, - "legalEntity" : "Individual" - } - }, - "post-createAccountHolder-individual-200" : { - "summary" : "Response code 200. Success.", - "value" : { - "invalidFields" : [ - ], - "pspReference" : "8516080413108716", - "accountCode" : "8516080413108724", - "accountHolderCode" : "GENERATE_CODE", - "accountHolderDetails" : { - "address" : { - "country" : "US" - }, - "bankAccountDetails" : [ - ], - "email" : "tim@green.com", - "individualDetails" : { - "name" : { - "firstName" : "Tim", - "gender" : "MALE", - "lastName" : "Green" - } - }, - "merchantCategoryCode" : "7999", - "payoutMethods" : [ - ], - "webAddress" : null - }, - "accountHolderStatus" : { - "status" : "Active", - "processingState" : { - "disabled" : false, - "processedFrom" : { - "currency" : "USD", - "value" : 0 - }, - "processedTo" : { - "currency" : "USD", - "value" : 9999 - }, - "tierNumber" : 0 - }, - "payoutState" : { - "allowPayout" : false, - "disabled" : false - }, - "events" : [ - ] - }, - "legalEntity" : "Individual", - "verification" : { - "accountHolder" : { - "checks" : [ - { - "type" : "IDENTITY_VERIFICATION", - "status" : "AWAITING_DATA", - "requiredFields" : [ - "AccountHolderDetails.Address.city", - "AccountHolderDetails.Address.houseNumberOrName", - "AccountHolderDetails.Address.postalCode", - "AccountHolderDetails.Address.street", - "AccountHolderDetails.IndividualDetails.PersonalData.idNumber", - "AccountHolderDetails.PhoneNumber.phoneNumber", - "AccountHolderDetails.IndividualDetails.PersonalData.personalData" - ] - }, - { - "type" : "PAYOUT_METHOD_VERIFICATION", - "status" : "AWAITING_DATA", - "requiredFields" : [ - "AccountHolderDetails.BankAccountDetails.bankAccount" - ] - } - ] - } - } - } - }, - "post-createAccountHolder-individual-422" : { "summary" : "Response code 422. Unprocessable Entity.", "value" : { "invalidFields" : [ diff --git a/json/AccountService-v4.json b/json/AccountService-v4.json index 7d38cc4..c73cf72 100644 --- a/json/AccountService-v4.json +++ b/json/AccountService-v4.json @@ -25,6 +25,9 @@ "paths" : { "/closeAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Close an account.", "description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments will be directed to your liable account.", "operationId" : "post-closeAccount", @@ -79,8 +82,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -104,8 +107,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -140,6 +143,9 @@ }, "/closeAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Close an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** status,the payments will be directed to your liable account.", "operationId" : "post-closeAccountHolder", @@ -194,8 +200,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -219,8 +225,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -255,6 +261,9 @@ }, "/createAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Create a new account.", "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", @@ -309,8 +318,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -334,8 +343,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -370,6 +379,9 @@ }, "/createAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Create a new account holder.", "description" : "Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", @@ -417,8 +429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -442,8 +454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -478,6 +490,9 @@ }, "/deleteBankAccounts" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete bank accounts.", "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", @@ -532,8 +547,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +572,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +608,9 @@ }, "/deleteShareholders" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete shareholders.", "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", @@ -647,8 +665,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -672,8 +690,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,6 +726,9 @@ }, "/deleteSignatories" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete signatories.", "description" : "Deletes one or more signatories from an account holder.", "operationId" : "post-deleteSignatories", @@ -757,8 +778,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -782,8 +803,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -818,6 +839,9 @@ }, "/getAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get an account holder.", "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", @@ -875,8 +899,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -900,8 +924,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -936,6 +960,9 @@ }, "/getTaxForm" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get a tax form.", "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms).", "operationId" : "post-getTaxForm", @@ -980,8 +1007,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1005,8 +1032,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1041,6 +1068,9 @@ }, "/getUploadedDocuments" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Get documents.", "description" : "Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).\n", "operationId" : "post-getUploadedDocuments", @@ -1085,8 +1115,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1110,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,6 +1176,9 @@ }, "/suspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Suspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", @@ -1200,8 +1233,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1225,8 +1258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1261,6 +1294,9 @@ }, "/unSuspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Unsuspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** status if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a KYC deadline expires.\n\nYou can only unsuspend account holders if they _do not_ have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", @@ -1315,8 +1351,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1340,8 +1376,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1376,6 +1412,9 @@ }, "/updateAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Update an account.", "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", @@ -1430,8 +1469,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1455,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1491,6 +1530,9 @@ }, "/updateAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update an account holder.", "description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the objects below.\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes along with other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation.\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n", "operationId" : "post-updateAccountHolder", @@ -1554,8 +1596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1579,8 +1621,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1615,6 +1657,9 @@ }, "/updateAccountHolderState" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update payout or processing state.", "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", @@ -1669,8 +1714,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1694,8 +1739,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1730,6 +1775,9 @@ }, "/uploadDocument" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Upload a document.", "description" : "Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).", "operationId" : "post-uploadDocument", @@ -1784,8 +1832,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1857,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1861,7 +1909,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account.", "type" : "string" }, @@ -1870,7 +1918,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "status" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.", "type" : "string" } @@ -1942,6 +1990,10 @@ "description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.", "type" : "object" }, + "principalBusinessAddress" : { + "description" : "The principal business address of the account holder.", + "$ref" : "#/components/schemas/ViasAddress" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -2008,7 +2060,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2034,7 +2086,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2174,8 +2226,15 @@ "description" : "The legal name of the company.", "type" : "string" }, + "listedUltimateParentCompany" : { + "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", + "items" : { + "$ref" : "#/components/schemas/UltimateParentCompany" + }, + "type" : "array" + }, "registrationNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The registration number of the company.", "type" : "string" }, @@ -2255,7 +2314,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -2289,7 +2348,7 @@ "type" : "boolean" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, @@ -2298,19 +2357,17 @@ "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" @@ -2337,17 +2394,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the new account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2355,14 +2412,12 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The type of legal entity of the new account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, @@ -2379,7 +2434,7 @@ "type" : "boolean" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -2399,7 +2454,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, @@ -2445,7 +2500,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, @@ -2462,7 +2517,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -2543,12 +2598,12 @@ "DocumentDetail" : { "properties" : { "accountHolderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of account holder, to which the document applies.", "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, @@ -2561,8 +2616,6 @@ "enum" : [ "BANK_STATEMENT", "BSN", - "COMPANY_REGISTRATION_SCREENING", - "CONSTITUTIONAL_DOCUMENT", "DRIVING_LICENCE", "DRIVING_LICENCE_BACK", "DRIVING_LICENCE_FRONT", @@ -2570,8 +2623,7 @@ "ID_CARD_BACK", "ID_CARD_FRONT", "PASSPORT", - "SSN", - "SUPPORTING_DOCUMENTS" + "SSN" ], "type" : "string" }, @@ -2580,7 +2632,7 @@ "type" : "string" }, "shareholderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, @@ -2711,6 +2763,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -2731,6 +2784,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -2802,7 +2856,7 @@ "type" : "string" }, "showDetails" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "True if the request should return the account holder details", "type" : "boolean" } @@ -2819,7 +2873,7 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -2831,7 +2885,7 @@ "type" : "array" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, @@ -2840,14 +2894,12 @@ "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2864,7 +2916,7 @@ "type" : "boolean" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -2884,7 +2936,7 @@ "type" : "string" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the Account Holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -2960,7 +3012,7 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of the Bank Account for which to retrieve the documents.", "type" : "string" }, @@ -3380,6 +3432,46 @@ "accountHolderStatus" ] }, + "UltimateParentCompany" : { + "properties" : { + "address" : { + "description" : "Address of the ultimate parent company.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "businessDetails" : { + "description" : "Details about the ultimate parent company's business.", + "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" + }, + "ultimateParentCompanyCode" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", + "type" : "string" + } + } + }, + "UltimateParentCompanyBusinessDetails" : { + "properties" : { + "legalBusinessName" : { + "description" : "The legal name of the company.", + "type" : "string" + }, + "registrationNumber" : { + "description" : "The registration number of the company.", + "type" : "string" + }, + "stockExchange" : { + "description" : "Market Identifier Code (MIC).", + "type" : "string" + }, + "stockNumber" : { + "description" : "International Securities Identification Number (ISIN).", + "type" : "string" + }, + "stockTicker" : { + "description" : "Stock Ticker symbol.", + "type" : "string" + } + } + }, "UnSuspendAccountHolderRequest" : { "properties" : { "accountHolderCode" : { @@ -3425,17 +3517,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.", "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier to which the Account Holder should be updated.\n>The processing tier can not be lowered through this request.\n\n>Required if accountHolderDetails are not provided.", "format" : "int32", "type" : "integer" @@ -3456,17 +3548,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3474,14 +3566,12 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The legal entity of the account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, @@ -3505,7 +3595,7 @@ "type" : "array" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -3556,7 +3646,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, @@ -3576,7 +3666,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, @@ -3743,7 +3833,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" @@ -3802,16 +3892,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad Request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: I", - "errorType" : "validation" - } - }, - "generic-403" : { + "generic" : { "summary" : "Response code 401. Forbidden.", "value" : { "status" : 403, diff --git a/json/AccountService-v5.json b/json/AccountService-v5.json index 46d6eab..d5a8c01 100644 --- a/json/AccountService-v5.json +++ b/json/AccountService-v5.json @@ -25,9 +25,12 @@ "paths" : { "/checkAccountHolder" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Trigger verification.", "description" : "Triggers the KYC verification for an account holder even if the checks are not yet required for the volume that they currently process.", - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "operationId" : "post-checkAccountHolder", "x-groupName" : "Verification", "x-sortIndex" : 3, @@ -80,8 +83,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -105,8 +108,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -141,6 +144,9 @@ }, "/closeAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Close an account.", "description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments will be directed to your liable account.", "operationId" : "post-closeAccount", @@ -195,8 +201,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -220,8 +226,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -256,6 +262,9 @@ }, "/closeAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Close an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** status,the payments will be directed to your liable account.", "operationId" : "post-closeAccountHolder", @@ -310,8 +319,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -335,8 +344,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -371,9 +380,12 @@ }, "/closeStores" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Close stores.", "description" : "Close one or more stores of the account holder.", - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "operationId" : "post-closeStores", "x-groupName" : "Account holders", "x-sortIndex" : 9, @@ -411,8 +423,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -436,8 +448,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -472,6 +484,9 @@ }, "/createAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Create a new account.", "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", @@ -526,8 +541,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -551,8 +566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -587,6 +602,9 @@ }, "/createAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Create a new account holder.", "description" : "Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", @@ -634,8 +652,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -659,8 +677,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -695,6 +713,9 @@ }, "/deleteBankAccounts" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete bank accounts.", "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", @@ -749,8 +770,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -774,8 +795,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -810,9 +831,12 @@ }, "/deletePayoutMethods" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete payout methods.", "description" : "Deletes one or more payout methods of an account holder.", - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "operationId" : "post-deletePayoutMethods", "x-groupName" : "Verification", "x-sortIndex" : 5, @@ -865,8 +889,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -890,8 +914,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -926,6 +950,9 @@ }, "/deleteShareholders" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete shareholders.", "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", @@ -980,8 +1007,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1005,8 +1032,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1041,6 +1068,9 @@ }, "/deleteSignatories" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete signatories.", "description" : "Deletes one or more signatories from an account holder.", "operationId" : "post-deleteSignatories", @@ -1090,8 +1120,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1115,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1151,6 +1181,9 @@ }, "/getAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get an account holder.", "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", @@ -1208,8 +1241,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,8 +1266,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1269,6 +1302,9 @@ }, "/getTaxForm" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get a tax form.", "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms).", "operationId" : "post-getTaxForm", @@ -1313,8 +1349,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1338,8 +1374,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1374,6 +1410,9 @@ }, "/getUploadedDocuments" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Get documents.", "description" : "Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).\n", "operationId" : "post-getUploadedDocuments", @@ -1418,8 +1457,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1443,8 +1482,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1479,6 +1518,9 @@ }, "/suspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Suspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", @@ -1533,8 +1575,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1558,8 +1600,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1594,6 +1636,9 @@ }, "/unSuspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Unsuspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** status if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a KYC deadline expires.\n\nYou can only unsuspend account holders if they _do not_ have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", @@ -1648,8 +1693,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1673,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1709,6 +1754,9 @@ }, "/updateAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Update an account.", "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", @@ -1763,8 +1811,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1788,8 +1836,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1824,6 +1872,9 @@ }, "/updateAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update an account holder.", "description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the objects below.\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes along with other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation.\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n", "operationId" : "post-updateAccountHolder", @@ -1887,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1912,8 +1963,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1948,6 +1999,9 @@ }, "/updateAccountHolderState" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update payout or processing state.", "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", @@ -2002,8 +2056,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2027,8 +2081,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2063,6 +2117,9 @@ }, "/uploadDocument" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Upload a document.", "description" : "Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).", "operationId" : "post-uploadDocument", @@ -2117,8 +2174,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2142,8 +2199,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2186,7 +2243,7 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, @@ -2199,12 +2256,12 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2212,7 +2269,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2221,7 +2278,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -2231,7 +2288,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.", "type" : "string" } @@ -2277,7 +2334,7 @@ "type" : "array" }, "bankAggregatorDataReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The opaque reference value returned by the Adyen API during bank account login.", "type" : "string" }, @@ -2309,15 +2366,19 @@ "type" : "object" }, "payoutMethods" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, "type" : "array" }, + "principalBusinessAddress" : { + "description" : "The principal business address of the account holder.", + "$ref" : "#/components/schemas/ViasAddress" + }, "storeDetails" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" @@ -2386,7 +2447,7 @@ "type" : "boolean" }, "notAllowedReason" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.", "type" : "string" }, @@ -2395,7 +2456,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2421,7 +2482,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2462,7 +2523,7 @@ "type" : "string" }, "bankAccountReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Merchant reference to the bank account.", "type" : "string" }, @@ -2566,8 +2627,15 @@ "description" : "The legal name of the company.", "type" : "string" }, + "listedUltimateParentCompany" : { + "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", + "items" : { + "$ref" : "#/components/schemas/UltimateParentCompany" + }, + "type" : "array" + }, "registrationNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The registration number of the company.", "type" : "string" }, @@ -2609,7 +2677,7 @@ "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2643,12 +2711,12 @@ "CloseAccountResponse" : { "properties" : { "accountCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account code of the account that is closed.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2664,7 +2732,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -2713,7 +2781,7 @@ "type" : "boolean" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, @@ -2722,19 +2790,17 @@ "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" @@ -2761,17 +2827,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the new account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2779,19 +2845,17 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The type of legal entity of the new account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2804,7 +2868,7 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -2824,17 +2888,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2842,7 +2906,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2873,7 +2937,7 @@ "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "default" : "STANDARD", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ @@ -2899,17 +2963,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2917,7 +2981,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2925,7 +2989,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2934,7 +2998,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -2952,7 +3016,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -3048,12 +3112,12 @@ "DocumentDetail" : { "properties" : { "accountHolderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of account holder, to which the document applies.", "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, @@ -3067,7 +3131,6 @@ "BANK_STATEMENT", "BSN", "COMPANY_REGISTRATION_SCREENING", - "CONSTITUTIONAL_DOCUMENT", "DRIVING_LICENCE", "DRIVING_LICENCE_BACK", "DRIVING_LICENCE_FRONT", @@ -3085,7 +3148,7 @@ "type" : "string" }, "shareholderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, @@ -3216,6 +3279,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -3236,6 +3300,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -3283,7 +3348,7 @@ "GenericResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3311,7 +3376,7 @@ "type" : "string" }, "showDetails" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "True if the request should return the account holder details", "type" : "boolean" } @@ -3328,7 +3393,7 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -3340,12 +3405,12 @@ "type" : "array" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3357,14 +3422,12 @@ "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -3377,13 +3440,13 @@ "type" : "string" }, "systemUpToDateTime" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The time that shows how up to date is the information in the response.", "format" : "date-time", "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -3403,12 +3466,12 @@ "type" : "string" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the Account Holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3463,7 +3526,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3487,7 +3550,7 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of the Bank Account for which to retrieve the documents.", "type" : "string" }, @@ -3510,7 +3573,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3632,13 +3695,13 @@ "KYCCheckSummary" : { "properties" : { "kycCheckCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes).", "format" : "int32", "type" : "integer" }, "kycCheckDescription" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A description of the check.", "type" : "string" } @@ -3688,7 +3751,7 @@ "type" : "array" }, "cards" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The results of the checks on the cards.", "items" : { "$ref" : "#/components/schemas/KYCCardCheckResult" @@ -3898,7 +3961,7 @@ "type" : "string" }, "shareholderReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Your reference for the shareholder entry.", "type" : "string" }, @@ -3985,7 +4048,7 @@ "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shopperInteraction" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", "enum" : [ "Ecommerce", @@ -3994,7 +4057,7 @@ "type" : "string" }, "splitConfigurationUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", "type" : "string" }, @@ -4023,12 +4086,12 @@ "type" : "string" }, "virtualAccount" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", "type" : "string" }, "webAddress" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "URL of the ecommerce store.", "type" : "string" } @@ -4058,7 +4121,7 @@ "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4078,6 +4141,46 @@ "accountHolderStatus" ] }, + "UltimateParentCompany" : { + "properties" : { + "address" : { + "description" : "Address of the ultimate parent company.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "businessDetails" : { + "description" : "Details about the ultimate parent company's business.", + "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" + }, + "ultimateParentCompanyCode" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", + "type" : "string" + } + } + }, + "UltimateParentCompanyBusinessDetails" : { + "properties" : { + "legalBusinessName" : { + "description" : "The legal name of the company.", + "type" : "string" + }, + "registrationNumber" : { + "description" : "The registration number of the company.", + "type" : "string" + }, + "stockExchange" : { + "description" : "Market Identifier Code (MIC).", + "type" : "string" + }, + "stockNumber" : { + "description" : "International Securities Identification Number (ISIN).", + "type" : "string" + }, + "stockTicker" : { + "description" : "Stock Ticker symbol.", + "type" : "string" + } + } + }, "UnSuspendAccountHolderRequest" : { "properties" : { "accountHolderCode" : { @@ -4096,7 +4199,7 @@ "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4127,29 +4230,27 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "legalEntity" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The legal entity type of the account holder. This determines the information that should be provided in the request.\n\nPossible values: **Business**, **Individual**, or **NonProfit**.\n\n* If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list.\n\n* If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.", "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier to which the Account Holder should be updated.\n>The processing tier can not be lowered through this request.\n\n>Required if accountHolderDetails are not provided.", "format" : "int32", "type" : "integer" @@ -4170,17 +4271,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4188,19 +4289,17 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The legal entity of the account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -4213,7 +4312,7 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -4264,17 +4363,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -4282,7 +4381,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -4291,7 +4390,7 @@ "$ref" : "#/components/schemas/UpdatePayoutScheduleRequest" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -4312,17 +4411,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/updateAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4330,7 +4429,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -4338,7 +4437,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -4347,7 +4446,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -4496,7 +4595,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" @@ -4550,16 +4649,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad Request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: I", - "errorType" : "validation" - } - }, - "generic-403" : { + "generic" : { "summary" : "Response code 401. Forbidden.", "value" : { "status" : 403, diff --git a/json/AccountService-v6.json b/json/AccountService-v6.json index a31f043..9c09fe2 100644 --- a/json/AccountService-v6.json +++ b/json/AccountService-v6.json @@ -25,9 +25,12 @@ "paths" : { "/checkAccountHolder" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Trigger verification.", "description" : "Triggers the KYC verification for an account holder even if the checks are not yet required for the volume that they currently process.", - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "operationId" : "post-checkAccountHolder", "x-groupName" : "Verification", "x-sortIndex" : 3, @@ -80,8 +83,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -105,8 +108,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -141,6 +144,9 @@ }, "/closeAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Close an account.", "description" : "Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments will be directed to your liable account.", "operationId" : "post-closeAccount", @@ -195,8 +201,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -220,8 +226,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -256,6 +262,9 @@ }, "/closeAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Close an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** status,the payments will be directed to your liable account.", "operationId" : "post-closeAccountHolder", @@ -310,8 +319,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -335,8 +344,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -371,9 +380,12 @@ }, "/closeStores" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Close stores.", "description" : "Close one or more stores of the account holder.", - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "operationId" : "post-closeStores", "x-groupName" : "Account holders", "x-sortIndex" : 9, @@ -411,8 +423,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -436,8 +448,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -472,6 +484,9 @@ }, "/createAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Create a new account.", "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", @@ -526,8 +541,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -551,8 +566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -587,6 +602,9 @@ }, "/createAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Create a new account holder.", "description" : "Creates an account holder, which [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", @@ -634,8 +652,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -659,8 +677,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -695,6 +713,9 @@ }, "/deleteBankAccounts" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete bank accounts.", "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", @@ -749,8 +770,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -774,8 +795,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -810,9 +831,12 @@ }, "/deletePayoutMethods" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete payout methods.", "description" : "Deletes one or more payout methods of an account holder.", - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "operationId" : "post-deletePayoutMethods", "x-groupName" : "Verification", "x-sortIndex" : 5, @@ -865,8 +889,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -890,8 +914,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -926,6 +950,9 @@ }, "/deleteShareholders" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete shareholders.", "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", @@ -980,8 +1007,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1005,8 +1032,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1041,6 +1068,9 @@ }, "/deleteSignatories" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Delete signatories.", "description" : "Deletes one or more signatories from an account holder.", "operationId" : "post-deleteSignatories", @@ -1090,8 +1120,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1115,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1151,6 +1181,9 @@ }, "/getAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get an account holder.", "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", @@ -1208,8 +1241,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,8 +1266,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1269,6 +1302,9 @@ }, "/getTaxForm" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Get a tax form.", "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/platforms/tax-forms).", "operationId" : "post-getTaxForm", @@ -1313,8 +1349,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1338,8 +1374,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1374,6 +1410,9 @@ }, "/getUploadedDocuments" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Get documents.", "description" : "Retrieves documents that were previously uploaded for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).\n", "operationId" : "post-getUploadedDocuments", @@ -1418,8 +1457,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1443,8 +1482,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1479,6 +1518,9 @@ }, "/suspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Suspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", @@ -1533,8 +1575,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1558,8 +1600,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1594,6 +1636,9 @@ }, "/unSuspendAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Unsuspend an account holder.", "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. Account holders can have a **Suspended** status if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a KYC deadline expires.\n\nYou can only unsuspend account holders if they _do not_ have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", @@ -1648,8 +1693,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1673,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1709,6 +1754,9 @@ }, "/updateAccount" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Update an account.", "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", @@ -1763,8 +1811,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1788,8 +1836,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1824,6 +1872,9 @@ }, "/updateAccountHolder" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update an account holder.", "description" : "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the objects below.\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes along with other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation.\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n", "operationId" : "post-updateAccountHolder", @@ -1887,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1912,8 +1963,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1948,6 +1999,9 @@ }, "/updateAccountHolderState" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Update payout or processing state.", "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", @@ -2002,8 +2056,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2027,8 +2081,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2063,6 +2117,9 @@ }, "/uploadDocument" : { "post" : { + "tags" : [ + "Verification" + ], "summary" : "Upload a document.", "description" : "Uploads a document for an account holder. Adyen uses the documents in the [KYC verification checks](https://docs.adyen.com/platforms/verification-checks).", "operationId" : "post-uploadDocument", @@ -2117,8 +2174,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2142,8 +2199,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2186,7 +2243,7 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, @@ -2199,12 +2256,12 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2212,7 +2269,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2221,7 +2278,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -2231,7 +2288,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.", "type" : "string" } @@ -2277,7 +2334,7 @@ "type" : "array" }, "bankAggregatorDataReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The opaque reference value returned by the Adyen API during bank account login.", "type" : "string" }, @@ -2298,8 +2355,8 @@ "$ref" : "#/components/schemas/IndividualDetails" }, "legalArrangements" : { - "x-addedInVersion" : 6, - "description" : "Array that contains information about legal arrangements, used when the account holder is acting on behalf of different parties or is part of a contractual business agreement.", + "x-addedInVersion" : "6", + "description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/platforms/verification-checks/legal-arrangements).", "items" : { "$ref" : "#/components/schemas/LegalArrangementDetail" }, @@ -2317,7 +2374,7 @@ "type" : "object" }, "payoutMethods" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" @@ -2325,12 +2382,11 @@ "type" : "array" }, "principalBusinessAddress" : { - "x-addedInVersion" : 6, - "description" : "The prinicipal business address of the account holder.", + "description" : "The principal business address of the account holder.", "$ref" : "#/components/schemas/ViasAddress" }, "storeDetails" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" @@ -2399,7 +2455,7 @@ "type" : "boolean" }, "notAllowedReason" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.", "type" : "string" }, @@ -2408,7 +2464,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2434,7 +2490,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -2475,7 +2531,7 @@ "type" : "string" }, "bankAccountReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Merchant reference to the bank account.", "type" : "string" }, @@ -2580,7 +2636,6 @@ "type" : "string" }, "listedUltimateParentCompany" : { - "x-addedInVersion" : 6, "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", "items" : { "$ref" : "#/components/schemas/UltimateParentCompany" @@ -2588,7 +2643,7 @@ "type" : "array" }, "registrationNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The registration number of the company.", "type" : "string" }, @@ -2607,17 +2662,17 @@ "type" : "array" }, "stockExchange" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Market Identifier Code (MIC).", "type" : "string" }, "stockNumber" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "International Securities Identification Number (ISIN).", "type" : "string" }, "stockTicker" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Stock Ticker symbol.", "type" : "string" }, @@ -2645,7 +2700,7 @@ "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2679,12 +2734,12 @@ "CloseAccountResponse" : { "properties" : { "accountCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account code of the account that is closed.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2700,7 +2755,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -2749,7 +2804,7 @@ "type" : "boolean" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, @@ -2765,18 +2820,18 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -2802,17 +2857,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the new account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2820,7 +2875,7 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The type of legal entity of the new account holder.", "enum" : [ "Business", @@ -2832,7 +2887,7 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2845,12 +2900,12 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -2870,17 +2925,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2888,7 +2943,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2919,7 +2974,7 @@ "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "default" : "STANDARD", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ @@ -2945,17 +3000,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2963,7 +3018,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2971,7 +3026,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2980,7 +3035,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -2998,7 +3053,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -3094,12 +3149,12 @@ "DocumentDetail" : { "properties" : { "accountHolderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of account holder, to which the document applies.", "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, @@ -3131,17 +3186,17 @@ "type" : "string" }, "legalArrangementCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The Adyen-generated [`legalArrangementCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementCode) to which the document must be linked.", "type" : "string" }, "legalArrangementEntityCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The Adyen-generated [`legalArrangementEntityCode`](https://docs.adyen.com/api-explorer/#/Account/v6/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementEntities-legalArrangementEntityCode) to which the document must be linked.", "type" : "string" }, "shareholderCode" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, @@ -3272,6 +3327,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -3292,6 +3348,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -3339,7 +3396,7 @@ "GenericResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3367,7 +3424,7 @@ "type" : "string" }, "showDetails" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "True if the request should return the account holder details", "type" : "boolean" } @@ -3384,7 +3441,7 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -3396,12 +3453,12 @@ "type" : "array" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3420,7 +3477,7 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -3433,18 +3490,18 @@ "type" : "string" }, "systemUpToDateTime" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The time that shows how up to date is the information in the response.", "format" : "date-time", "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -3464,12 +3521,12 @@ "type" : "string" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the Account Holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3524,7 +3581,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3548,7 +3605,7 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The code of the Bank Account for which to retrieve the documents.", "type" : "string" }, @@ -3571,7 +3628,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3663,13 +3720,13 @@ "KYCCheckSummary" : { "properties" : { "kycCheckCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes).", "format" : "int32", "type" : "integer" }, "kycCheckDescription" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A description of the check.", "type" : "string" } @@ -3734,12 +3791,12 @@ "type" : "array" }, "legalArrangementCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique ID of the legal arrangement to which the shareholder belongs, if applicable.", "type" : "string" }, "legalArrangementEntityCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable.", "type" : "string" }, @@ -3774,7 +3831,7 @@ "type" : "array" }, "ultimateParentCompanyCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The code of the Ultimate Parent Company to which the check applies.", "type" : "string" } @@ -3787,7 +3844,7 @@ "$ref" : "#/components/schemas/KYCCheckResult2" }, "legalArrangements" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The results of the checks on the legal arrangements.", "items" : { "$ref" : "#/components/schemas/KYCLegalArrangementCheckResult" @@ -3795,7 +3852,7 @@ "type" : "array" }, "legalArrangementsEntities" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The results of the checks on the legal arrangement entities.", "items" : { "$ref" : "#/components/schemas/KYCLegalArrangementEntityCheckResult" @@ -3803,7 +3860,7 @@ "type" : "array" }, "payoutMethods" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The results of the checks on the payout methods.", "items" : { "$ref" : "#/components/schemas/KYCPayoutMethodCheckResult" @@ -3825,7 +3882,7 @@ "type" : "array" }, "ultimateParentCompany" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The result of the check on the Ultimate Parent Company.", "items" : { "$ref" : "#/components/schemas/KYCUltimateParentCompanyCheckResult" @@ -3837,7 +3894,7 @@ "LegalArrangementDetail" : { "properties" : { "address" : { - "description" : "The address of the legal arrangement member.", + "description" : "The address of the legal arrangement.", "$ref" : "#/components/schemas/ViasAddress" }, "legalArrangementCode" : { @@ -3845,7 +3902,7 @@ "type" : "string" }, "legalArrangementEntities" : { - "description" : "Array that contains information about the entities or members that are part of the legal arrangement.", + "description" : "An array containing information about other entities that are part of the legal arrangement.", "items" : { "$ref" : "#/components/schemas/LegalArrangementEntityDetail" }, @@ -3856,7 +3913,7 @@ "type" : "string" }, "legalForm" : { - "description" : "The structure of the legal arrangement as defined according to legislations in the country.\n\n Possible values: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, **UnlistedPublicUnitTrust**, **LimitedPartnership**, **FamilyPartnership**, **OtherPartnership**.", + "description" : "The form of legal arrangement. Required if `type` is **Trust** or **Partnership**.\n\nThe possible values depend on the `type`.\n\n- For `type` **Trust**: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**.\n\n- For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, or **OtherPartnership**", "enum" : [ "CashManagementTrust", "CorporateUnitTrust", @@ -3880,7 +3937,7 @@ "type" : "string" }, "name" : { - "description" : "The legal name of the legal arrangement.", + "description" : "The legal name of the legal arrangement. Minimum length: 3 characters.", "type" : "string" }, "registrationNumber" : { @@ -3892,14 +3949,21 @@ "type" : "string" }, "type" : { - "description" : "The type of legal arrangement.\n\nPossible values:\n\n- **Trust** - A legal agreement where the account holder is a trustee that manages assets for beneficiaries.\n- **Partnership** - A legal arrangement where the account holder is a partner that has an agreement with one or more partners to manage, operate and share profits of their jointly-owned business.", + "description" : "The [type of legal arrangement](https://docs.adyen.com/platforms/verification-checks/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n", "enum" : [ + "Association", "Partnership", + "SoleProprietorship", "Trust" ], "type" : "string" } - } + }, + "required" : [ + "type", + "name", + "address" + ] }, "LegalArrangementEntityDetail" : { "properties" : { @@ -3924,7 +3988,7 @@ "$ref" : "#/components/schemas/IndividualDetails" }, "legalArrangementEntityCode" : { - "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity.", + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. Required when updating an existing legal arrangement entity entry in an `/updateAccountHolder` request.", "type" : "string" }, "legalArrangementEntityReference" : { @@ -3932,18 +3996,15 @@ "type" : "string" }, "legalArrangementMembers" : { - "description" : "The roles of the entity in the legal arrangement. The values depend on the `legalArragementType`.\n\nPossible values:\n\n- For `legalArragementType` **Trust**, you can use **Trustee**, **Settlor**, **Protector**, **Beneficiary**, or **Shareholder**.\n\n- For `legalArragementType` **Partnership**, you can use **Partner** or **Shareholder**. ", + "description" : "An array containing the roles of the entity in the legal arrangement.\n\nThe possible values depend on the legal arrangement `type`.\n\n- For `type` **Association**: **ControllingPerson** and **Shareholder**.\n\n- For `type` **Partnership**: **Partner** and **Shareholder**.\n\n- For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**, and **Shareholder**.\n\n", "items" : { "enum" : [ - "Associate", "Beneficiary", - "Chairman", + "ControllingPerson", "Partner", "Protector", - "Secretary", "Settlor", "Shareholder", - "Treasurer", "Trustee" ], "type" : "string" @@ -4161,7 +4222,7 @@ "type" : "string" }, "shareholderReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Your reference for the shareholder entry.", "type" : "string" }, @@ -4248,7 +4309,7 @@ "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shopperInteraction" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", "enum" : [ "Ecommerce", @@ -4257,7 +4318,7 @@ "type" : "string" }, "splitConfigurationUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", "type" : "string" }, @@ -4286,12 +4347,12 @@ "type" : "string" }, "virtualAccount" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", "type" : "string" }, "webAddress" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "URL of the ecommerce store.", "type" : "string" } @@ -4321,7 +4382,7 @@ "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4344,17 +4405,14 @@ "UltimateParentCompany" : { "properties" : { "address" : { - "x-addedInVersion" : 6, "description" : "Address of the ultimate parent company.", "$ref" : "#/components/schemas/ViasAddress" }, "businessDetails" : { - "x-addedInVersion" : 6, "description" : "Details about the ultimate parent company's business.", "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" }, "ultimateParentCompanyCode" : { - "x-addedInVersion" : 6, "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", "type" : "string" } @@ -4367,22 +4425,18 @@ "type" : "string" }, "registrationNumber" : { - "x-addedInVersion" : 4, "description" : "The registration number of the company.", "type" : "string" }, "stockExchange" : { - "x-addedInVersion" : 6, "description" : "Market Identifier Code (MIC).", "type" : "string" }, "stockNumber" : { - "x-addedInVersion" : 6, "description" : "International Securities Identification Number (ISIN).", "type" : "string" }, "stockTicker" : { - "x-addedInVersion" : 6, "description" : "Stock Ticker symbol.", "type" : "string" } @@ -4406,7 +4460,7 @@ "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4437,12 +4491,12 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "legalEntity" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The legal entity type of the account holder. This determines the information that should be provided in the request.\n\nPossible values: **Business**, **Individual**, or **NonProfit**.\n\n* If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list.\n\n* If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided.", "enum" : [ "Business", @@ -4454,18 +4508,18 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.", "type" : "string" }, "processingTier" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier to which the Account Holder should be updated.\n>The processing tier can not be lowered through this request.\n\n>Required if accountHolderDetails are not provided.", "format" : "int32", "type" : "integer" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -4485,17 +4539,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4503,7 +4557,7 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The legal entity of the account holder.", "enum" : [ "Business", @@ -4515,7 +4569,7 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -4528,12 +4582,12 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -4584,17 +4638,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -4602,7 +4656,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -4611,7 +4665,7 @@ "$ref" : "#/components/schemas/UpdatePayoutScheduleRequest" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -4632,17 +4686,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/updateAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4650,7 +4704,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -4658,7 +4712,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -4667,7 +4721,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -4816,7 +4870,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" @@ -4870,16 +4924,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad Request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: I", - "errorType" : "validation" - } - }, - "generic-403" : { + "generic" : { "summary" : "Response code 401. Forbidden.", "value" : { "status" : 403, diff --git a/json/BalancePlatformNotificationService-v1.json b/json/BalancePlatformNotificationService-v1.json new file mode 100644 index 0000000..bbe7e35 --- /dev/null +++ b/json/BalancePlatformNotificationService-v1.json @@ -0,0 +1,1724 @@ +{ + "openapi" : "3.1.0", + "info" : { + "version" : "1", + "x-publicVersion" : true, + "title" : "Balance Platform Notification Webhooks", + "description" : "Adyen sends notifications through webhooks to inform your system about events that occur in the balance platform. These events include when a card user makes a payment, or when a merchant starts a refund. When an event occurs, Adyen makes an HTTP POST request to a URL on your server and includes the details of the event in the request body.\n\nYou can use webhooks to build your implementations. For example, you can use the information to update balances in your own dashboards or to keep track of incoming funds.\n\nRefer to [Notification webhooks](https://docs.adyen.com/issuing/notification-webhooks) for more information.", + "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", + "contact" : { + "name" : "Adyen Developer Experience team", + "url" : "https://www.adyen.help/hc/en-us/community/topics", + "email" : "developer-experience@adyen.com" + } + }, + "x-groups" : [ + "Account holder and balance account", + "Payment Instrument", + "Authorisation, refund, or transfer requests", + "Fund movements" + ], + "x-staticResponse" : "response.json", + "webhooks" : { + "balancePlatform.accountHolder.created" : { + "post" : { + "tags" : [ + "Account holder and balance account" + ], + "summary" : "Sent when an account holder has been created.", + "description" : "Adyen sends this webhook after you successfully [create an account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders).", + "operationId" : "post-alancePlatform.accountHolder.created", + "x-groupName" : "Account holder and balance account", + "x-sortIndex" : 5, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccountHolderNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.accountHolder.updated" : { + "post" : { + "tags" : [ + "Account holder and balance account" + ], + "summary" : "Sent when an account holder has been updated.", + "description" : "Adyen sends this webhook after you successfully [update an account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/accountHolders/{id}).", + "operationId" : "post-alancePlatform.accountHolder.updated", + "x-groupName" : "Account holder and balance account", + "x-sortIndex" : 5, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccountHolderNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.balanceAccount.created" : { + "post" : { + "tags" : [ + "Account holder and balance account" + ], + "summary" : "Sent when a balance account has been created.", + "description" : "Adyen sends this webhook after you successfully [create a balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts).", + "operationId" : "post-alancePlatform.balanceAccount.created", + "x-groupName" : "Account holder and balance account", + "x-sortIndex" : 5, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalanceAccountNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.incomingTransfer.created" : { + "post" : { + "tags" : [ + "Fund movements" + ], + "summary" : "Sent when there is a pending incoming transfer.", + "description" : "Adyen sends this webhook when there are incoming funds due to a refund or a fund transfer. Use the `paymentId` to link to the original refund request or funds transfer request. Check the content of the webhook to differentiate the events.\n\n* For refunds, the webhook includes the payment instrument to which funds will be refunded.\n\n* For incoming fund transfers, the webhook only includes information about the balance account.", + "operationId" : "post-alancePlatform.incomingTransfer.created", + "x-groupName" : "Fund movements", + "x-sortIndex" : 1, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IncomingTransferNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.incomingTransfer.updated" : { + "post" : { + "tags" : [ + "Fund movements" + ], + "summary" : "Sent when funds were added to a balance account.", + "description" : "Adyen sends this webhook when funds were added to the balance account. This could be due to a refund or a funds transfer. Use the `data.id` to track the original incoming transfer resource in the `balancePlatform.incomingTransfer.created` webhook.\n\nThe `status` field indicates the event that triggered the webhook. \n\n* For refunds, the `status` will be **Refunded**. \n\n* For incoming fund transfers, the `status` will be **IncomingTransfer**.", + "operationId" : "post-alancePlatform.incomingTransfer.updated", + "x-groupName" : "Fund movements", + "x-sortIndex" : 1, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IncomingTransferNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.outgoingTransfer.created" : { + "post" : { + "tags" : [ + "Fund movements" + ], + "summary" : "Sent when funds were deducted from a balance account.", + "description" : "Adyen sends this webhook when funds were deducted from a balance account due to a capture or a funds transfer. Use the `paymentId` to link to the original payment authorisation or funds transfer request.\n\nThe `status` field indicates the event that triggered the webhook. \n\n* For captures, the `status` will be **Captured**. \n\n* For outgoing fund transfers, the `status` will be **OutgoingTransfer**.", + "operationId" : "post-alancePlatform.outgoingTransfer.created", + "x-groupName" : "Fund movements", + "x-sortIndex" : 1, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OutgoingTransferNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.outgoingTransfer.updated" : { + "post" : { + "tags" : [ + "Fund movements" + ], + "summary" : "Sent when there is an update after funds were deducted from a balance account.", + "description" : "Adyen sends this webhook when there is updated information after funds have been deducted from a balance account. For example, if the fund transfer failed.\n\nUse the `data.id` to track the original outgoing transfer resource from the `balancePlatform.outgoingTransfer.created` webhook.", + "operationId" : "post-alancePlatform.outgoingTransfer.updated", + "x-groupName" : "Fund movements", + "x-sortIndex" : 1, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OutgoingTransferNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.payment.created" : { + "post" : { + "tags" : [ + "Authorisation, refund, or transfer requests" + ], + "summary" : "Sent when a payment authorisation, refund, or funds transfer has been initiated. ", + "description" : "Adyen sends this webhook when a payment authorisation, a refund, or a funds transfer has been initiated. This webhook only informs your server of requests. For the actual fund movements, you'll get the information from the subsequent outgoing or incoming transfer webhooks.\n\n To differentiate the requests, check the content of the webhook.\n\n* For payments, the webhook contains the authorisation result, information about the processing merchant, and shows a negative amount.\n\n * For refunds, the webhook contains to which payment instrument the funds will be refunded, and shows a positive amount.\n\n* For outgoing or incoming fund transfers, the webhook shows a positive or negative amount depending on the direction of the transfer, and only includes information about the balance account.\n\nRefer to webhooks for [payment events](https://docs.adyen.com/issuing/notification-types/payment-events) and [fund transfers](https://docs.adyen.com/issuing/notification-types/fund-transfers-webhooks) for more information.", + "operationId" : "post-alancePlatform.payment.created", + "x-groupName" : "Authorisation, refund, or transfer requests", + "x-sortIndex" : 1, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PaymentNotificationRequest2" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.payment.updated" : { + "post" : { + "tags" : [ + "Authorisation, refund, or transfer requests" + ], + "summary" : "Sent when a payment authorisation has expired or has been cancelled.", + "description" : "Adyen sends this webhook when a payment authorisation has expired or has been cancelled. Use the `data.id` to track the original payment authorisation from the `balancePlatform.payment.created` webhook.", + "operationId" : "post-alancePlatform.payment.updated", + "x-groupName" : "Authorisation, refund, or transfer requests", + "x-sortIndex" : 1, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PaymentNotificationRequest2" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.paymentInstrument.created" : { + "post" : { + "tags" : [ + "Payment Instrument" + ], + "summary" : "Sent when a payment instrument has been created.", + "description" : "Adyen sends this webhook after you successfully [create a payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments). When creating a virtual card, note that the notification does not include the card number. You can only get the card number in the POST response.", + "operationId" : "post-alancePlatform.paymentInstrument.created", + "x-groupName" : "Payment Instrument", + "x-sortIndex" : 3, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PaymentNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "balancePlatform.paymentInstrument.updated" : { + "post" : { + "tags" : [ + "Payment Instrument" + ], + "summary" : "Sent when a payment instrument has been updated.", + "description" : "Adyen sends this webhook after you successfully [update a payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/patch/paymentInstruments/{id}). ", + "operationId" : "post-alancePlatform.paymentInstrument.updated", + "x-groupName" : "Payment Instrument", + "x-sortIndex" : 3, + "security" : [ + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PaymentNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BalancePlatformNotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + } + }, + "components" : { + "schemas" : { + "AccountHolder" : { + "properties" : { + "balancePlatform" : { + "description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) where the account holder belongs. Required in the request if your API credentials has access to multiple balance platforms.", + "type" : "string" + }, + "contactDetails" : { + "description" : "Contact details of the account holder.", + "$ref" : "#/components/schemas/ContactDetails" + }, + "description" : { + "description" : "Your description for the account holder, maximum 300 characters.", + "maxLength" : 300, + "type" : "string" + }, + "id" : { + "description" : "Unique identifier of the account holder.", + "type" : "string" + }, + "legalEntityId" : { + "description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) associated with the account holder. Adyen performs the Know Your Customer (KYC) verification process against the legal entity of the account holder.\n\nTo create a legal entity, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).", + "type" : "string" + }, + "reference" : { + "description" : "Your reference to the account holder, maximum 150 characters.", + "maxLength" : 150, + "type" : "string" + }, + "status" : { + "description" : "The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This the default status when creating an account holder. \n\n * **Suspended**: The account holder is temporarily suspended. You can set the account back to active or permanently close the account. \n\n* **Closed**: The account holder is permanently closed. This action cannot be undone.", + "enum" : [ + "Active", + "Closed", + "Inactive", + "Suspended" + ], + "type" : "string" + }, + "sweepConfigurations" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/SweepConfiguration" + }, + "description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\n Sweep configurations on the account holder level applies to all the account holder's balance accounts.\n\n The key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format and in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.\n\n", + "type" : "object" + } + }, + "required" : [ + "contactDetails", + "id" + ] + }, + "AccountHolderNotificationData" : { + "properties" : { + "accountHolder" : { + "$ref" : "#/components/schemas/AccountHolder" + }, + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + } + } + }, + "AccountHolderNotificationRequest" : { + "properties" : { + "data" : { + "description" : "Contains the event details.", + "$ref" : "#/components/schemas/AccountHolderNotificationData" + }, + "environment" : { + "description" : "The environment from where the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "The type of the notification.", + "enum" : [ + "balancePlatform.accountHolder.updated", + "balancePlatform.accountHolder.created" + ], + "type" : "string" + } + } + }, + "Address2" : { + "properties" : { + "city" : { + "description" : "The name of the city.", + "type" : "string" + }, + "country" : { + "description" : "The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.", + "type" : "string" + }, + "houseNumberOrName" : { + "description" : "The number or name of the house.", + "type" : "string" + }, + "postalCode" : { + "description" : "A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.", + "type" : "string" + }, + "stateOrProvince" : { + "description" : "State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.", + "type" : "string" + }, + "street" : { + "description" : "The name of the street.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.", + "type" : "string" + } + }, + "required" : [ + "street", + "houseNumberOrName", + "city", + "postalCode", + "country" + ] + }, + "Amount" : { + "properties" : { + "currency" : { + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "maxLength" : 3, + "minLength" : 3, + "type" : "string" + }, + "value" : { + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "format" : "int64", + "type" : "integer" + } + }, + "required" : [ + "value", + "currency" + ] + }, + "Authentication" : { + "properties" : { + "password" : { + "description" : "The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters.\n\n- Characters between **a-z**, **A-Z**, and **0-9**\n\n- Special characters: **äöüßÄÖÜ+-*/ç%()=?!~#'\",;:$&àùòâôûáúó**", + "type" : "string" + }, + "phone" : { + "description" : "The phone number where the one-time password (OTP) is sent.\n\nThis object must have:\n\n- A `type` set to **mobile**.\n\n- A `number` with a valid country code.\n\n- A `number` with more than 4 digits, excluding the country code.\n\n>Make sure to verify that the card user owns the phone number.", + "$ref" : "#/components/schemas/Phone" + } + } + }, + "Balance" : { + "properties" : { + "available" : { + "description" : "The remaining amount available for spending.", + "format" : "int64", + "type" : "integer" + }, + "balance" : { + "description" : "The total amount in the balance.", + "format" : "int64", + "type" : "integer" + }, + "currency" : { + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.", + "type" : "string" + }, + "reserved" : { + "description" : "The amount reserved for payments that have been authorised, but have not been captured yet.", + "format" : "int64", + "type" : "integer" + } + }, + "required" : [ + "currency", + "balance", + "reserved", + "available" + ] + }, + "BalanceAccount" : { + "properties" : { + "accountHolderId" : { + "description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}) associated with the balance account.", + "type" : "string" + }, + "balances" : { + "description" : "List of balances with the amount and currency.", + "items" : { + "$ref" : "#/components/schemas/Balance" + }, + "type" : "array" + }, + "defaultCurrencyCode" : { + "description" : "The default currency code of this balance account, in three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format.\nThe default value is **EUR**.", + "type" : "string" + }, + "description" : { + "description" : "A human-readable description of the balance account, maximum 300 characters. You can use this parameter to help distinguish between multiple balance accounts under an account holder.", + "maxLength" : 300, + "type" : "string" + }, + "id" : { + "description" : "Unique identifier of the balance account.", + "type" : "string" + }, + "paymentInstruments" : { + "description" : "List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}__queryParam_id) associated with the balance account.", + "items" : { + "$ref" : "#/components/schemas/PaymentInstrumentReference" + }, + "type" : "array" + }, + "reference" : { + "description" : "Your reference to the balance account, maximum 150 characters.", + "maxLength" : 150, + "type" : "string" + }, + "status" : { + "description" : "The status of the balance account, set to **Active** by default. \n", + "type" : "string" + }, + "sweepConfigurations" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/SweepConfiguration" + }, + "description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\nSweep configurations on the balance account override [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/accountHolders__reqParam_sweepConfigurations) configurations.\n\nThe key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format and in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.", + "type" : "object" + } + }, + "required" : [ + "accountHolderId", + "id" + ] + }, + "BalanceAccountNotificationData" : { + "properties" : { + "balanceAccount" : { + "$ref" : "#/components/schemas/BalanceAccount" + }, + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + } + } + }, + "BalanceAccountNotificationRequest" : { + "properties" : { + "data" : { + "description" : "Contains the event details.", + "$ref" : "#/components/schemas/BalanceAccountNotificationData" + }, + "environment" : { + "description" : "The environment from where the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "The type of the notification.", + "enum" : [ + "balancePlatform.balanceAccount.updated", + "balancePlatform.balanceAccount.created" + ], + "type" : "string" + } + } + }, + "BalancePlatformNotificationData" : { + "properties" : { + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "Date and time when the resource was created, in ISO 8601 extended offset date-time format. For example, `2020-12-18T10:15:30+01:00`.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + } + } + }, + "BalancePlatformNotificationResponse" : { + "properties" : { + "notificationResponse" : { + "description" : "Respond with an **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/issuing/notification-webhooks#accept-notifications).", + "type" : "string" + } + } + }, + "Card" : { + "properties" : { + "authentication" : { + "description" : "Authentication details for 3D Secure and wallet activation.", + "$ref" : "#/components/schemas/Authentication" + }, + "bin" : { + "description" : "The BIN of the card number.", + "type" : "string" + }, + "brand" : { + "description" : "The brand for the payment instrument.\nPossible values: **visa**, **mc**.", + "type" : "string" + }, + "brandVariant" : { + "description" : "The brand variant for the payment instrument.\n>Contact your Adyen Implementation Manager to get the values that are relevant to your integration. Examples: **visadebit**, **mcprepaid**.", + "type" : "string" + }, + "cardholderName" : { + "description" : "The name of the card holder. Maximum length 26 characters.", + "type" : "string" + }, + "configuration" : { + "description" : "Specific settings for this card, including the configuration profile.", + "$ref" : "#/components/schemas/CardConfiguration" + }, + "cvc" : { + "description" : "The CVC2 value of the card.\n> The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards.", + "type" : "string" + }, + "deliveryContact" : { + "description" : "The delivery contact (name and address) for physical card delivery.", + "$ref" : "#/components/schemas/Contact" + }, + "expiration" : { + "description" : "The expiration date of the card.", + "$ref" : "#/components/schemas/Expiry" + }, + "formFactor" : { + "description" : "The form factor of the card.\nPossible values: **virtual**, **physical**.", + "enum" : [ + "physical", + "unknown", + "virtual" + ], + "type" : "string" + }, + "lastFour" : { + "description" : "Last last four digits of the card number.", + "type" : "string" + }, + "number" : { + "description" : "The primary account number of the card.\n> The primary account number is masked by default. The full primary account number is only returned for single-use virtual cards.", + "readOnly" : true, + "type" : "string" + } + }, + "required" : [ + "formFactor", + "cardholderName", + "brand", + "brandVariant", + "number" + ] + }, + "CardConfiguration" : { + "properties" : { + "activationUrl" : { + "description" : "The activation URL of the card configuration profile.", + "type" : "string" + }, + "cardImageId" : { + "description" : "The Entity Reference of the card image.", + "type" : "string" + }, + "carrierImageId" : { + "description" : "The Entity Reference of the carrier image.", + "type" : "string" + }, + "configurationProfileId" : { + "description" : "The ID of the card configuration profile.", + "type" : "string" + }, + "currency" : { + "description" : "The ISO-4217 currency code for the card. For example **EUR**.", + "type" : "string" + }, + "language" : { + "description" : "The ISO-639-1 application language for the card. For example, **en**.", + "type" : "string" + }, + "logoImageId" : { + "description" : "The Entity Reference of the logo image.", + "type" : "string" + } + } + }, + "Contact" : { + "properties" : { + "address" : { + "description" : "The address of the contact.", + "$ref" : "#/components/schemas/Address2" + }, + "email" : { + "description" : "The e-mail address of the contact.", + "type" : "string" + }, + "fullPhoneNumber" : { + "description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", + "type" : "string" + }, + "name" : { + "description" : "The name of the contact.", + "$ref" : "#/components/schemas/Name2" + }, + "personalData" : { + "description" : "Personal data of the contact.", + "$ref" : "#/components/schemas/PersonalData" + }, + "phoneNumber" : { + "description" : "The phone number of the contact.", + "$ref" : "#/components/schemas/PhoneNumber2" + }, + "webAddress" : { + "description" : "The URL of the website of the contact.", + "type" : "string" + } + } + }, + "ContactDetails" : { + "properties" : { + "address" : { + "description" : "The address of the account holder.", + "$ref" : "#/components/schemas/Address2" + }, + "email" : { + "description" : "The e-mail address of the account holder.", + "type" : "string" + }, + "phone" : { + "description" : "The phone number of the account holder.", + "$ref" : "#/components/schemas/Phone" + }, + "webAddress" : { + "description" : "URL to the website of the account holder.", + "type" : "string" + } + }, + "required" : [ + "email", + "phone", + "address" + ] + }, + "Expiry" : { + "properties" : { + "month" : { + "description" : "The month in which the card will expire.", + "type" : "string" + }, + "year" : { + "description" : "The year in which the card will expire.", + "type" : "string" + } + } + }, + "IncomingTransferNotificationData" : { + "properties" : { + "accountHolder" : { + "description" : "Contains information about the account holder.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "amount" : { + "description" : "The amount converted to the balance account's currency, in case the original transaction currency is different.\n\n * A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "balanceAccount" : { + "description" : "Contains information about the balance account.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "Date and time when the resource was created, in ISO 8601 extended offset date-time format. For example, `2020-12-18T10:15:30+01:00`.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + }, + "originalAmount" : { + "description" : "The amount in the original currency of the transaction.\n\n* A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "paymentId" : { + "description" : "The ID of the original payment authorisation, refund, or funds transfer request. Use this to trace the original request from the `balancePlatform.payment.created` webhook.", + "type" : "string" + }, + "paymentInstrument" : { + "description" : "Contains information about the payment instrument.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "platformPayment" : { + "description" : "Contains information about the related platform payment.", + "$ref" : "#/components/schemas/PlatformPayment" + }, + "status" : { + "description" : "The event status. The possible values depend on the `type`.\n\n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created` \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed** for type `balancePlatform.outgoingTransfer.updated`\n\n ", + "type" : "string" + }, + "valueDate" : { + "description" : "Indicates the expected settlement date of this transaction.", + "format" : "date-time", + "type" : "string" + } + } + }, + "IncomingTransferNotificationRequest" : { + "properties" : { + "data" : { + "description" : "Contains details about the event.", + "$ref" : "#/components/schemas/IncomingTransferNotificationData" + }, + "environment" : { + "description" : "The environment from where the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "The type of the notification.", + "enum" : [ + "balancePlatform.incomingTransfer.updated", + "balancePlatform.incomingTransfer.created" + ], + "type" : "string" + } + } + }, + "MerchantData" : { + "properties" : { + "mcc" : { + "description" : "The merchant category code.", + "type" : "string" + }, + "merchantId" : { + "description" : "The merchant identifier.", + "type" : "string" + }, + "nameLocation" : { + "description" : "Contains the merchant's name and location.", + "$ref" : "#/components/schemas/NameLocation" + } + } + }, + "Name2" : { + "properties" : { + "firstName" : { + "description" : "The first name.", + "type" : "string" + }, + "lastName" : { + "description" : "The last name.", + "type" : "string" + } + }, + "required" : [ + "firstName", + "lastName" + ] + }, + "NameLocation" : { + "properties" : { + "city" : { + "description" : "The city where the merchant is located.", + "type" : "string" + }, + "country" : { + "description" : "The country where the merchant is located in [three-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format.", + "type" : "string" + }, + "countryOfOrigin" : { + "description" : "The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) format, used for government-controlled merchants such as embassies.", + "type" : "string" + }, + "name" : { + "description" : "The name of the merchant's shop or service.", + "type" : "string" + }, + "rawData" : { + "description" : "The raw data.", + "type" : "string" + }, + "state" : { + "description" : "The state where the merchant is located.", + "type" : "string" + } + } + }, + "NotificationModificationData" : { + "properties" : { + "amount" : { + "description" : "The modification amount converted to the balance account's currency, in case the original transaction currency is different.\n\n * A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "description" : "The type of the modification that generates this notification.", + "type" : "string" + } + } + }, + "OutgoingTransferNotificationData" : { + "properties" : { + "accountHolder" : { + "description" : "Contains information about the account holder.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "amount" : { + "description" : "The amount converted to the balance account's currency, in case the original transaction currency is different.\n\n * A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "balanceAccount" : { + "description" : "Contains information about the balance account.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "Date and time when the resource was created, in ISO 8601 extended offset date-time format. For example, `2020-12-18T10:15:30+01:00`.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + }, + "merchantData" : { + "description" : "Contains information about the merchant that processed the payment. This object is only included for payment authorisation requests and captures.", + "$ref" : "#/components/schemas/MerchantData" + }, + "originalAmount" : { + "description" : "The amount in the original currency of the transaction.\n\n* A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "paymentId" : { + "description" : "The ID of the original payment authorisation, refund, or funds transfer request. Use this to trace the original request from the `balancePlatform.payment.created` webhook.", + "type" : "string" + }, + "paymentInstrument" : { + "description" : "Contains information about the payment instrument.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "platformPayment" : { + "description" : "Contains information about the related platform payment.", + "$ref" : "#/components/schemas/PlatformPayment" + }, + "processingType" : { + "description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for point-of-sale payments.", + "type" : "string" + }, + "purposeCode" : { + "description" : "Indicates the purpose of the transaction. Adyen sets this to **payout** when transferring funds out of the balance platform.", + "type" : "string" + }, + "relayedAuthorisationData" : { + "description" : "If you're using [relayed authorisation](https://docs.adyen.com/issuing/processing-payments-for-cards#relayed-authorisation), this object contains information from the relayed authorisation response from your server.", + "$ref" : "#/components/schemas/RelayedAuthorisationData" + }, + "status" : { + "description" : "The event status. The possible values depend on the `type`.\n\n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created` \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed** for type `balancePlatform.outgoingTransfer.updated`\n\n ", + "type" : "string" + }, + "transactionRulesResult" : { + "description" : "Contains results from the evaluation of [transaction rules](https://docs.adyen.com/issuing/transaction-rules).", + "$ref" : "#/components/schemas/TransactionRulesResult" + }, + "valueDate" : { + "description" : "Indicates the expected settlement date of this transaction.", + "format" : "date-time", + "type" : "string" + } + } + }, + "OutgoingTransferNotificationRequest" : { + "properties" : { + "data" : { + "description" : "Contains details about the event.", + "$ref" : "#/components/schemas/OutgoingTransferNotificationData" + }, + "environment" : { + "description" : "The environment from where the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "The type of the notification.", + "enum" : [ + "balancePlatform.outgoingTransfer.created", + "balancePlatform.outgoingTransfer.updated" + ], + "type" : "string" + } + } + }, + "PaymentInstrument" : { + "properties" : { + "balanceAccountId" : { + "description" : "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) associated with the payment instrument.", + "type" : "string" + }, + "card" : { + "description" : "Contains information about the card payment instrument.", + "$ref" : "#/components/schemas/Card" + }, + "description" : { + "description" : "Your description for the payment instrument, maximum 300 characters.", + "maxLength" : 300, + "type" : "string" + }, + "id" : { + "description" : "Unique identifier of the payment instrument.", + "type" : "string" + }, + "issuingCountryCode" : { + "description" : "Country where the payment instrument is being issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**, **US**.", + "type" : "string" + }, + "paymentInstrumentGroupId" : { + "description" : "The ID of a payment instrument group that this payment instrument is part of.", + "type" : "string" + }, + "reference" : { + "description" : "Your reference to the payment instrument, maximum 150 characters.", + "maxLength" : 150, + "type" : "string" + }, + "status" : { + "x-enum" : [ + { + "description" : "The payment instrument has been requested. This state is applicable when creating physical cards.", + "value" : "Requested" + }, + { + "description" : "The payment instrument is active and can be used to make payments.", + "value" : "Active" + }, + { + "description" : "The payment instrument is inactive and cannot be used to make payments.", + "value" : "Inactive" + }, + { + "description" : "The payment instrument is temporarily suspended and cannot be used to make payments.", + "value" : "Suspended" + }, + { + "description" : "The payment instrument is permanently closed. This action cannot be undone.", + "value" : "Closed" + } + ], + "description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, the status is set to **Active** by default. However, there can be exceptions based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards issued in the US, the default status is **Requested**.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable when creating physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ", + "enum" : [ + "Active", + "Closed", + "Inactive", + "Lost", + "Requested", + "Stolen", + "Suspended" + ], + "type" : "string" + }, + "type" : { + "description" : "The type of payment instrument.\n\nPossible value: **card** ", + "enum" : [ + "bankAccount", + "card", + "unknown" + ], + "type" : "string" + } + }, + "required" : [ + "balanceAccountId", + "issuingCountryCode", + "type", + "id" + ] + }, + "PaymentInstrumentNotificationData" : { + "properties" : { + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + }, + "paymentInstrument" : { + "$ref" : "#/components/schemas/PaymentInstrument" + } + } + }, + "PaymentInstrumentReference" : { + "properties" : { + "id" : { + "description" : "Unique identifier of the payment instrument.", + "type" : "string" + } + }, + "required" : [ + "id" + ] + }, + "PaymentNotificationData" : { + "properties" : { + "accountHolder" : { + "description" : "Contains information about the account holder.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "amount" : { + "description" : "The amount converted to the balance account's currency, in case the original transaction currency is different.\n\n * A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "authCode" : { + "description" : "The authorisation code for the payment.", + "type" : "string" + }, + "balanceAccount" : { + "description" : "Contains information about the balance account.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "Date and time when the resource was created, in ISO 8601 extended offset date-time format. For example, `2020-12-18T10:15:30+01:00`.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + }, + "merchantData" : { + "description" : "Contains information about the merchant that processed the payment. This object is only included for payment authorisation requests and captures.", + "$ref" : "#/components/schemas/MerchantData" + }, + "originalAmount" : { + "description" : "The amount in the original currency of the transaction.\n\n* A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "paymentInstrument" : { + "description" : "Contains information about the payment instrument.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "platformPayment" : { + "description" : "Contains information about the related platform payment.", + "$ref" : "#/components/schemas/PlatformPayment" + }, + "processingType" : { + "description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for point-of-sale payments.", + "type" : "string" + }, + "relayedAuthorisationData" : { + "description" : "If you're using [relayed authorisation](https://docs.adyen.com/issuing/processing-payments-for-cards#relayed-authorisation), this object contains information from the relayed authorisation response from your server.", + "$ref" : "#/components/schemas/RelayedAuthorisationData" + }, + "status" : { + "description" : "The event status. The possible values depend on the `type`.\n\n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created` \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed** for type `balancePlatform.outgoingTransfer.updated`\n\n ", + "type" : "string" + }, + "transactionRulesResult" : { + "description" : "Contains results from the evaluation of [transaction rules](https://docs.adyen.com/issuing/transaction-rules).", + "$ref" : "#/components/schemas/TransactionRulesResult" + }, + "validationResult" : { + "description" : "Array of checks that Adyen performed to validate the payment and the result of each.", + "items" : { + "$ref" : "#/components/schemas/ValidationResult" + }, + "type" : "array" + } + } + }, + "PaymentNotificationRequest" : { + "properties" : { + "data" : { + "description" : "Contains the event details.", + "$ref" : "#/components/schemas/PaymentInstrumentNotificationData" + }, + "environment" : { + "description" : "The environment from where the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "The type of the notification.", + "enum" : [ + "balancePlatform.paymentInstrument.created", + "balancePlatform.paymentInstrument.updated" + ], + "type" : "string" + } + } + }, + "PaymentNotificationRequest2" : { + "properties" : { + "data" : { + "description" : "Contains details about the event.", + "$ref" : "#/components/schemas/PaymentNotificationData" + }, + "environment" : { + "description" : "The environment from where the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "The type of the notification.", + "enum" : [ + "balancePlatform.payment.created", + "balancePlatform.payment.updated" + ], + "type" : "string" + } + } + }, + "PersonalData" : { + "properties" : { + "dateOfBirth" : { + "description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).", + "type" : "string" + }, + "idNumber" : { + "description" : "An ID number of the person.", + "type" : "string" + }, + "nationality" : { + "description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "maxLength" : 2, + "minLength" : 2, + "type" : "string" + } + } + }, + "Phone" : { + "properties" : { + "number" : { + "description" : "The full phone number provided as a single string. \nFor example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031) 611223344\"**.", + "type" : "string" + }, + "type" : { + "description" : "The type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n", + "enum" : [ + "Landline", + "Mobile" + ], + "type" : "string" + } + }, + "required" : [ + "number", + "type" + ] + }, + "PhoneNumber2" : { + "properties" : { + "phoneCountryCode" : { + "description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').", + "type" : "string" + }, + "phoneNumber" : { + "description" : "The phone number.\n>The inclusion of the phone number country code is not necessary.", + "type" : "string" + }, + "phoneType" : { + "description" : "The type of the phone number.\n>The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`.", + "enum" : [ + "Fax", + "Landline", + "Mobile", + "SIP" + ], + "type" : "string" + } + }, + "required" : [ + "phoneCountryCode", + "phoneNumber" + ] + }, + "PlatformPayment" : { + "properties" : { + "account" : { + "description" : "The account given in the related split.", + "type" : "string" + }, + "description" : { + "description" : "The description of the related split.", + "type" : "string" + }, + "modificationMerchantReference" : { + "description" : "The merchant reference of the modification.", + "type" : "string" + }, + "modificationPspReference" : { + "description" : "The pspReference of the modification.", + "type" : "string" + }, + "paymentMerchantReference" : { + "description" : "The merchant reference of the payment.", + "type" : "string" + }, + "paymentPspReference" : { + "description" : "The pspReference of the payment.", + "type" : "string" + }, + "reference" : { + "description" : "The reference of the related split.", + "type" : "string" + }, + "type" : { + "description" : "The type of the related split.", + "enum" : [ + "BalanceAccount", + "Commission", + "Default", + "PaymentFee", + "VAT" + ], + "type" : "string" + } + } + }, + "RelayedAuthorisationData" : { + "properties" : { + "metadata" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "The `metadata` object from the relayed authorisation response from your server.", + "type" : "object" + }, + "reference" : { + "description" : "The `reference` from the relayed authorisation response from your server.", + "type" : "string" + }, + "status" : { + "description" : "The value can be can be **Authorised** or **Refused**, based on the `authorisationDecision.status` in the relayed authorisation response from your server.", + "type" : "string" + } + } + }, + "ResourceReference" : { + "properties" : { + "description" : { + "description" : "The description of the resource.", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the resource.", + "type" : "string" + }, + "reference" : { + "description" : "The reference of the resource.", + "type" : "string" + } + } + }, + "SweepConfiguration" : { + "properties" : { + "balanceAccountId" : { + "description" : "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}) that will be the source or destination of the balance sweep. This can only be used for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account that will be the source of funds. You can only use this if you are processing payments with Adyen. This can only be used for sweeps of `type` **pull** and `schedule.type` **balance**.", + "type" : "string" + }, + "schedule" : { + "description" : "The schedule when the `triggerAmount` is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.", + "$ref" : "#/components/schemas/SweepSchedule" + }, + "sweepAmount" : { + "description" : "The amount that must be pushed out or pulled in. You can configure only one of `sweepAmount` or `targetAmount`.", + "$ref" : "#/components/schemas/Amount" + }, + "targetAmount" : { + "description" : "The amount that must be available in the balance account after the sweep. You can configure only one of `sweepAmount` or `targetAmount`.", + "$ref" : "#/components/schemas/Amount" + }, + "transferInstrumentId" : { + "description" : "Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/transferInstruments/{id}__queryParam_id) that will be the source or destination of the balance sweep. This can only be used for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.", + "type" : "string" + }, + "triggerAmount" : { + "description" : "The threshold amount that triggers the sweep. If not specified, the amount defaults to zero. The `triggerAmount` is evaluated at the specified `schedule.type`.\n\n* For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, funds will be pulled in to the balance account.\n\n* For `type` **push**, if the balance is more than or equal to the `triggerAmount`, funds will be pushed out of the balance account.", + "$ref" : "#/components/schemas/Amount" + }, + "type" : { + "default" : "push", + "description" : "The direction of sweep. Possible values:\n\n * **push**: _Push funds out_ to a destination balance account or transfer instrument.\n\n * **pull**: _Pull funds in_ from a source merchant account or balance account. ", + "enum" : [ + "pull", + "push" + ], + "type" : "string" + } + }, + "required" : [ + "schedule", + "type" + ] + }, + "SweepSchedule" : { + "properties" : { + "type" : { + "description" : "The schedule type.\n\nPossible values:\n\n* **daily**: Push out funds daily at 07:00 AM CET.\n\n* **weekly**: Push out funds every Monday at 07:00 AM CET.\n\n* **monthly**: Push out funds every 1st of the month at 07:00 AM CET.\n\n* **balance**: Only for sweeps of `type` **pull** and with a `merchantAccount` source. Pull in funds instantly if the balance is less than or equal to the `triggerAmount`.", + "enum" : [ + "balance", + "daily", + "monthly", + "weekly" + ], + "type" : "string" + } + } + }, + "TransactionEventViolation" : { + "properties" : { + "reason" : { + "description" : "An explanation about why the transaction rule failed.", + "type" : "string" + }, + "transactionRule" : { + "description" : "Contains information about the transaction rule.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "transactionRuleSource" : { + "description" : "Contains the type and ID of the resource where the transaction rule is linked.", + "$ref" : "#/components/schemas/TransactionRuleSource" + } + } + }, + "TransactionNotificationData" : { + "properties" : { + "accountHolder" : { + "description" : "Contains information about the account holder.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "amount" : { + "description" : "The amount converted to the balance account's currency, in case the original transaction currency is different.\n\n * A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "authCode" : { + "description" : "The authorisation code for the payment.", + "type" : "string" + }, + "balanceAccount" : { + "description" : "Contains information about the balance account.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "balancePlatform" : { + "description" : "The ID of the balance platform.", + "type" : "string" + }, + "creationDate" : { + "description" : "Date and time when the resource was created, in ISO 8601 extended offset date-time format. For example, `2020-12-18T10:15:30+01:00`.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "The ID of the resource.", + "type" : "string" + }, + "merchantData" : { + "description" : "Contains information about the merchant that processed the payment. This object is only included for payment authorisation requests and captures.", + "$ref" : "#/components/schemas/MerchantData" + }, + "originalAmount" : { + "description" : "The amount in the original currency of the transaction.\n\n* A _positive_ value means an addition to the balance account, as a result of a refund or an incoming transfer.\n\n * A _negative_ value means a deduction from the balance account, as a result of a payment or an outgoing transfer. ", + "$ref" : "#/components/schemas/Amount" + }, + "paymentId" : { + "description" : "The ID of the original payment authorisation, refund, or funds transfer request. Use this to trace the original request from the `balancePlatform.payment.created` webhook.", + "type" : "string" + }, + "paymentInstrument" : { + "description" : "Contains information about the payment instrument.", + "$ref" : "#/components/schemas/ResourceReference" + }, + "platformPayment" : { + "description" : "Contains information about the related platform payment.", + "$ref" : "#/components/schemas/PlatformPayment" + }, + "processingType" : { + "description" : "Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for point-of-sale payments.", + "type" : "string" + }, + "purposeCode" : { + "description" : "Indicates the purpose of the transaction. Adyen sets this to **payout** when transferring funds out of the balance platform.", + "type" : "string" + }, + "relayedAuthorisationData" : { + "description" : "If you're using [relayed authorisation](https://docs.adyen.com/issuing/processing-payments-for-cards#relayed-authorisation), this object contains information from the relayed authorisation response from your server.", + "$ref" : "#/components/schemas/RelayedAuthorisationData" + }, + "status" : { + "description" : "The event status. The possible values depend on the `type`.\n\n* **Authorised**, **Refused**, or **Error** for type `balancePlatform.payment.created`\n\n * **Expired** or **Cancelled** for type `balancePlatform.payment.updated`\n\n* **PendingIncomingTransfer** for type `balancePlatform.incomingTransfer.created` \n\n* **Refunded** or **IncomingTransfer** for type `balancePlatform.incomingTransfer.updated`\n\n * **Captured** or **OutgoingTransfer** for type `balancePlatform.outgoingTransfer.created`\n\n* **TransferConfirmed**, **TransferSentOut**, or **TransferFailed** for type `balancePlatform.outgoingTransfer.updated`\n\n ", + "type" : "string" + }, + "transactionRulesResult" : { + "description" : "Contains results from the evaluation of [transaction rules](https://docs.adyen.com/issuing/transaction-rules).", + "$ref" : "#/components/schemas/TransactionRulesResult" + }, + "validationResult" : { + "description" : "Array of checks that Adyen performed to validate the payment and the result of each.", + "items" : { + "$ref" : "#/components/schemas/ValidationResult" + }, + "type" : "array" + }, + "valueDate" : { + "description" : "Indicates the expected settlement date of this transaction.", + "format" : "date-time", + "type" : "string" + } + } + }, + "TransactionRuleSource" : { + "properties" : { + "id" : { + "description" : "ID of the resource, when applicable.", + "type" : "string" + }, + "type" : { + "description" : "Indicates the type of resource for which the transaction rule is defined.\n\nPossible values:\n\n - **PaymentInstrumentGroup**\n\n- **PaymentInstrument**\n\n- **BalancePlatform**\n\n- **EntityUsageConfiguration**\n\n- **PlatformRule**: The transaction rule is a platform-wide rule imposed by Adyen.", + "type" : "string" + } + } + }, + "TransactionRulesResult" : { + "properties" : { + "allRulesPassed" : { + "description" : "Whether the transaction passed the evaluation for all transaction rules.", + "type" : "boolean" + }, + "failedTransactionRules" : { + "description" : "Array containing all the transaction rules that the transaction violated. This list is only sent when `allRulesPassed` is **false**.", + "items" : { + "$ref" : "#/components/schemas/TransactionEventViolation" + }, + "type" : "array" + } + } + }, + "ValidationResult" : { + "properties" : { + "result" : { + "description" : "The result of the check.\n\nPossible values:\n\n- **valid** - The validation was successful.\n\n- **invalid** - The validation failed.\n\n- **notValidated** - The validation was not performed because some services were unreachable or Adyen does not have the information needed to perform the check.\n\n- **notApplicable** - The validation is not applicable.", + "type" : "string" + }, + "type" : { + "description" : "The type of check.", + "type" : "string" + } + } + } + }, + "securitySchemes" : { + "ApiKeyAuth" : { + "in" : "header", + "name" : "X-API-Key", + "type" : "apiKey" + }, + "BasicAuth" : { + "scheme" : "basic", + "type" : "http" + } + }, + "examples" : { + + } + } +} \ No newline at end of file diff --git a/json/BalancePlatformService-v1.json b/json/BalancePlatformService-v1.json index 0b9a24f..590d2bd 100644 --- a/json/BalancePlatformService-v1.json +++ b/json/BalancePlatformService-v1.json @@ -31,13 +31,20 @@ "paths" : { "/accountHolders" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Create an account holder.", "description" : "Creates an account holder. This resource represents your user's entity within the balance platform.\n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-accountHolders", "x-groupName" : "Account holders", "x-sortIndex" : 1, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -62,8 +69,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/post-accountHolders-success-200" + "success" : { + "$ref" : "#/components/examples/post-accountHolders-success" } }, "schema" : { @@ -77,8 +84,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -92,8 +99,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +114,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +129,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +144,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -153,13 +160,20 @@ }, "/accountHolders/{id}" : { "get" : { + "tags" : [ + "Account holders" + ], "summary" : "Retrieve an account holder.", "description" : "Returns a specific account holder.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-accountHolders-id", "x-groupName" : "Account holders", "x-sortIndex" : 3, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -181,8 +195,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-accountHolders-id-success-200" + "success" : { + "$ref" : "#/components/examples/get-accountHolders-id-success" } }, "schema" : { @@ -196,8 +210,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -211,8 +225,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -226,8 +240,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -241,8 +255,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -256,8 +270,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -270,13 +284,20 @@ } }, "patch" : { + "tags" : [ + "Account holders" + ], "summary" : "Update an account holder.", "description" : "Updates a specific account holder. When updating an account holder resource, note that:\n\n* If a parameter is not provided in the request, the parameter is left unchanged.\n\n* When updating any parameter in the `contactDetails` object, you must send all other existing `contactDetails` parameters.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "patch-accountHolders-id", "x-groupName" : "Account holders", "x-sortIndex" : 2, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -312,8 +333,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/patch-accountHolders-id-success-200" + "success" : { + "$ref" : "#/components/examples/patch-accountHolders-id-success" } }, "schema" : { @@ -327,8 +348,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -342,8 +363,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -357,8 +378,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -372,8 +393,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +408,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -403,13 +424,20 @@ }, "/accountHolders/{id}/balanceAccounts" : { "get" : { + "tags" : [ + "Account holders" + ], "summary" : "Retrieve all balance accounts of a specific account holder.", "description" : "Returns a paginated list of balance accounts associated with a specific account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and to skip the first 10: `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-accountHolders-id-balanceAccounts", "x-groupName" : "Account holders", "x-sortIndex" : 4, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -451,8 +479,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-accountHolders-id-balanceAccounts-success-200" + "success" : { + "$ref" : "#/components/examples/get-accountHolders-id-balanceAccounts-success" } }, "schema" : { @@ -466,8 +494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -481,8 +509,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -496,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -511,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -526,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,13 +570,20 @@ }, "/balanceAccounts" : { "post" : { + "tags" : [ + "Balance accounts" + ], "summary" : "Create a balance account.", "description" : "Creates a balance account. The balance account resource holds the funds of the associated account holder. \n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-balanceAccounts", "x-groupName" : "Balance accounts", "x-sortIndex" : 1, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -573,8 +608,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/post-balanceAccounts-success-200" + "success" : { + "$ref" : "#/components/examples/post-balanceAccounts-success" } }, "schema" : { @@ -588,8 +623,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +638,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -618,8 +653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -633,8 +668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -648,8 +683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -664,13 +699,20 @@ }, "/balanceAccounts/{id}" : { "get" : { + "tags" : [ + "Balance accounts" + ], "summary" : "Retrieve a balance account.", "description" : "Returns a specific balance account.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-balanceAccounts-id", "x-groupName" : "Balance accounts", "x-sortIndex" : 3, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -692,8 +734,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balanceAccounts-id-success-200" + "success" : { + "$ref" : "#/components/examples/get-balanceAccounts-id-success" } }, "schema" : { @@ -707,8 +749,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -722,8 +764,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -737,8 +779,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -752,8 +794,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -767,8 +809,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -783,13 +825,20 @@ }, "/balanceAccounts/{id}/paymentInstruments" : { "get" : { + "tags" : [ + "Balance accounts" + ], "summary" : "Retrieve all payment instruments for a specific balance account.", "description" : "Returns a paginated list of the payment instruments associated with a specific balance account. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 3 payment instruments and to skip the first 6: `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-balanceAccounts-id-paymentInstruments", "x-groupName" : "Balance accounts", "x-sortIndex" : 4, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -831,8 +880,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200" + "success" : { + "$ref" : "#/components/examples/get-balanceAccounts-id-paymentInstruments-success" } }, "schema" : { @@ -846,8 +895,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -861,8 +910,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -876,8 +925,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -891,8 +940,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -906,8 +955,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -922,13 +971,20 @@ }, "/balancePlatforms/{id}" : { "get" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a balance platform.", "description" : "Returns a specific balance platform.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-balancePlatforms-id", "x-groupName" : "General", "x-sortIndex" : 0, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -950,8 +1006,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balancePlatforms-id-success-200" + "success" : { + "$ref" : "#/components/examples/get-balancePlatforms-id-success" } }, "schema" : { @@ -965,8 +1021,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -980,8 +1036,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -995,8 +1051,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1010,8 +1066,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1025,8 +1081,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1041,13 +1097,20 @@ }, "/balancePlatforms/{id}/accountHolders" : { "get" : { + "tags" : [ + "General" + ], "summary" : "Retrieve all account holders under a specific balance platform.", "description" : "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 account holders and to skip the first 20: `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-balancePlatforms-id-accountHolders", "x-groupName" : "General", "x-sortIndex" : 0, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1089,8 +1152,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-balancePlatforms-id-accountHolders-success-200" + "success" : { + "$ref" : "#/components/examples/get-balancePlatforms-id-accountHolders-success" } }, "schema" : { @@ -1104,8 +1167,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1119,8 +1182,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1134,8 +1197,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1149,8 +1212,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1164,8 +1227,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1180,13 +1243,20 @@ }, "/documents" : { "post" : { + "tags" : [ + "Documents" + ], "summary" : "Upload a document for verification checks.", "description" : "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) to run automated Know Your Customer checks. If these checks fail, your Adyen contact will inform you so you can provide additional documents. Adyen uses the documents to validate the identity of the individual or organization legal entity, or the legal entity's bank account details.\n\n You should only upload documents when your Adyen contact informs you to provide additional information for the legal entity. For more information, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-documents", "x-groupName" : "Documents", "x-sortIndex" : 4, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1216,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1231,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1246,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1261,8 +1331,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1276,8 +1346,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1292,13 +1362,20 @@ }, "/documents/{id}" : { "delete" : { + "tags" : [ + "Documents" + ], "summary" : "Delete a document.", "description" : "Deletes a document.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "delete-documents-id", "x-groupName" : "Documents", "x-sortIndex" : 7, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1330,8 +1407,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1345,8 +1422,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1360,8 +1437,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1375,8 +1452,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1390,8 +1467,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1404,13 +1481,20 @@ } }, "get" : { + "tags" : [ + "Documents" + ], "summary" : "Retrieve a document.", "description" : "Returns a specific document.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-documents-id", "x-groupName" : "Documents", "x-sortIndex" : 5, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1442,8 +1526,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1457,8 +1541,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1472,8 +1556,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1487,8 +1571,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1502,8 +1586,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1516,13 +1600,20 @@ } }, "patch" : { + "tags" : [ + "Documents" + ], "summary" : "Update a document.", "description" : "Updates a specific document.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "patch-documents-id", "x-groupName" : "Documents", "x-sortIndex" : 6, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1563,8 +1654,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1578,8 +1669,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1593,8 +1684,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1608,8 +1699,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1623,8 +1714,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1639,13 +1730,20 @@ }, "/legalEntities" : { "post" : { + "tags" : [ + "Legal entities" + ], "summary" : "Create a legal entity.", "description" : "Creates a legal entity. This resource contains information about an individual or organization that will be onboarded on your balance platform. Adyen uses this information to perform Know Your Customer (KYC) checks as required by payment industry regulations. Your Adyen contact will inform you of the status and results of the KYC checks. \n\nWhen the legal entity passes the verification checks, you can issue a card to them. For more information, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-legalEntities", "x-groupName" : "Legal entities", "x-sortIndex" : 1, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1675,8 +1773,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1690,8 +1788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1705,8 +1803,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1720,8 +1818,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1735,8 +1833,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1751,13 +1849,20 @@ }, "/legalEntities/{id}" : { "get" : { + "tags" : [ + "Legal entities" + ], "summary" : "Retrieve a legal entity.", "description" : "Returns a specific legal entity.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-legalEntities-id", "x-groupName" : "Legal entities", "x-sortIndex" : 2, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1789,8 +1894,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1804,8 +1909,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1819,8 +1924,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1834,8 +1939,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1849,8 +1954,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1863,13 +1968,20 @@ } }, "patch" : { + "tags" : [ + "Legal entities" + ], "summary" : "Update a legal entity.", "description" : "Updates a legal entity. When updating a legal entity resource, note that:\n\n * To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "patch-legalEntities-id", "x-groupName" : "Legal entities", "x-sortIndex" : 3, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -1910,8 +2022,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1925,8 +2037,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1940,8 +2052,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1955,8 +2067,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1970,8 +2082,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1986,13 +2098,20 @@ }, "/paymentInstrumentGroups" : { "post" : { + "tags" : [ + "Payment instrument groups" + ], "summary" : "Create a payment instrument group.", "description" : "Creates a payment instrument group, which you use to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-paymentInstrumentGroups", "x-groupName" : "Payment instrument groups", "x-sortIndex" : 1, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2017,8 +2136,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/post-paymentInstrumentGroups-success-200" + "success" : { + "$ref" : "#/components/examples/post-paymentInstrumentGroups-success" } }, "schema" : { @@ -2032,8 +2151,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2047,8 +2166,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2062,8 +2181,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2077,8 +2196,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2092,8 +2211,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2108,13 +2227,20 @@ }, "/paymentInstrumentGroups/{id}" : { "get" : { + "tags" : [ + "Payment instrument groups" + ], "summary" : "Retrieve a payment instrument group.", "description" : "Returns a specific payment instrument group.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-paymentInstrumentGroups-id", "x-groupName" : "Payment instrument groups", "x-sortIndex" : 2, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2136,8 +2262,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success-200" + "success" : { + "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success" } }, "schema" : { @@ -2151,8 +2277,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2166,8 +2292,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2181,8 +2307,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2196,8 +2322,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2211,8 +2337,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2227,13 +2353,20 @@ }, "/paymentInstrumentGroups/{id}/transactionRules" : { "get" : { + "tags" : [ + "Payment instrument groups" + ], "summary" : "Retrieve all transaction rules for a specific payment instruments group.", "description" : "Returns a list of all the transaction rules associated with a specific payment instrument group.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-paymentInstrumentGroups-id-transactionRules", "x-groupName" : "Payment instrument groups", "x-sortIndex" : 3, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2255,8 +2388,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200" + "success" : { + "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success" } }, "schema" : { @@ -2270,8 +2403,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2285,8 +2418,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2300,8 +2433,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2315,8 +2448,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2330,8 +2463,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2346,13 +2479,20 @@ }, "/paymentInstruments" : { "post" : { + "tags" : [ + "Payment instruments" + ], "summary" : "Create a payment instrument.", "description" : "Creates a payment instrument, which results in issuing either a physical or a virtual card to your user.\n\n For more information, refer to [Create cards](https://docs.adyen.com/issuing/create-cards).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-paymentInstruments", "x-groupName" : "Payment instruments", "x-sortIndex" : 11, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2380,8 +2520,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/post-paymentInstruments-success-200" + "success" : { + "$ref" : "#/components/examples/post-paymentInstruments-success" } }, "schema" : { @@ -2395,8 +2535,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2410,8 +2550,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2425,8 +2565,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2440,8 +2580,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2455,8 +2595,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2471,13 +2611,20 @@ }, "/paymentInstruments/{id}" : { "get" : { + "tags" : [ + "Payment instruments" + ], "summary" : "Retrieve a payment instrument.", "description" : "Returns a specific payment instrument.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-paymentInstruments-id", "x-groupName" : "Payment instruments", "x-sortIndex" : 13, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2499,8 +2646,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-success-200" + "success" : { + "$ref" : "#/components/examples/get-paymentInstruments-id-success" } }, "schema" : { @@ -2514,8 +2661,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2529,8 +2676,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2544,8 +2691,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2559,8 +2706,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2574,8 +2721,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2588,13 +2735,20 @@ } }, "patch" : { + "tags" : [ + "Payment instruments" + ], "summary" : "Update a payment instrument.", "description" : "Updates a specific payment instrument. Once a payment instrument is already active, you can only update the status. However, for cards created with a **Requested** or **Inactive** status, you can still update the balance account associated with the card.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "patch-paymentInstruments-id", "x-groupName" : "Payment instruments", "x-sortIndex" : 12, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2633,8 +2787,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/patch-paymentInstruments-id-success-200" + "success" : { + "$ref" : "#/components/examples/patch-paymentInstruments-id-success" } }, "schema" : { @@ -2648,8 +2802,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2663,8 +2817,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2678,8 +2832,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2693,11 +2847,11 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" }, - "invalidData-422" : { - "$ref" : "#/components/examples/patch-paymentInstruments-id-invalidData-422" + "invalidData" : { + "$ref" : "#/components/examples/patch-paymentInstruments-id-invalidData" } }, "schema" : { @@ -2711,8 +2865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2727,13 +2881,20 @@ }, "/paymentInstruments/{id}/transactionRules" : { "get" : { + "tags" : [ + "Payment instruments" + ], "summary" : "Retrieve all transaction rules for a specific payment instrument.", "description" : "Returns a list of transaction rules associated to a specific payment instrument.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-paymentInstruments-id-transactionRules", "x-groupName" : "Payment instruments", "x-sortIndex" : 14, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2755,8 +2916,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success-200" + "success" : { + "$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success" } }, "schema" : { @@ -2770,8 +2931,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,8 +2946,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2800,8 +2961,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2815,8 +2976,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2830,8 +2991,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2846,13 +3007,20 @@ }, "/transactionRules" : { "post" : { + "tags" : [ + "Transaction rules" + ], "summary" : "Create a transaction rule.", "description" : "Creates a transaction rule. Transaction rules define conditions to automatically approve or deny transactions. You can apply transaction rules to a specific payment instrument, a group of payment instruments, or to all the payment instruments in your balance platform.\n\nFor more information on how you can set conditions, refer to [Transaction rules](https://docs.adyen.com/issuing/transaction-rules).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-transactionRules", "x-groupName" : "Transaction rules", "x-sortIndex" : 1, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2877,8 +3045,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/post-transactionRules-success-200" + "success" : { + "$ref" : "#/components/examples/post-transactionRules-success" } }, "schema" : { @@ -2892,8 +3060,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2907,8 +3075,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2922,8 +3090,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2937,8 +3105,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2952,8 +3120,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2968,13 +3136,20 @@ }, "/transactionRules/{transactionRuleId}" : { "delete" : { + "tags" : [ + "Transaction rules" + ], "summary" : "Delete a transaction rule.", "description" : "Deletes a transaction rule.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "delete-transactionRules-transactionRuleId", "x-groupName" : "Transaction rules", "x-sortIndex" : 5, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -2996,8 +3171,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/delete-transactionRules-transactionRuleId-success-200" + "success" : { + "$ref" : "#/components/examples/delete-transactionRules-transactionRuleId-success" } }, "schema" : { @@ -3011,8 +3186,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3026,8 +3201,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3041,8 +3216,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3056,8 +3231,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3071,8 +3246,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3085,13 +3260,20 @@ } }, "get" : { + "tags" : [ + "Transaction rules" + ], "summary" : "Retrieve a transaction rule.", "description" : "Returns a specific transaction rule.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-transactionRules-transactionRuleId", "x-groupName" : "Transaction rules", "x-sortIndex" : 2, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -3113,8 +3295,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/get-transactionRules-transactionRuleId-success-200" + "success" : { + "$ref" : "#/components/examples/get-transactionRules-transactionRuleId-success" } }, "schema" : { @@ -3128,8 +3310,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3143,8 +3325,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3158,8 +3340,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3173,8 +3355,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3188,8 +3370,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3202,13 +3384,20 @@ } }, "patch" : { + "tags" : [ + "Transaction rules" + ], "summary" : "Update a transaction rule.", "description" : "Updates a transaction rule. When updating a transaction rule resource, note that: \n\n* When updating only the `status`, you can send only the `status` parameter. All other parameters not provided in the request are left unchanged.\n\n* When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, the parameter is removed from the resource.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "patch-transactionRules-transactionRuleId", "x-groupName" : "Transaction rules", "x-sortIndex" : 3, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -3244,8 +3433,8 @@ "content" : { "application/json" : { "examples" : { - "success-200" : { - "$ref" : "#/components/examples/patch-transactionRules-transactionRuleId-success-200" + "success" : { + "$ref" : "#/components/examples/patch-transactionRules-transactionRuleId-success" } }, "schema" : { @@ -3259,8 +3448,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3274,8 +3463,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3289,8 +3478,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3304,8 +3493,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3319,8 +3508,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3335,13 +3524,20 @@ }, "/transferInstruments" : { "post" : { + "tags" : [ + "Transfer instruments" + ], "summary" : "Create a transfer instrument.", "description" : "Creates a transfer instrument. A transfer instrument is a bank account or other payment details that a legal entity owns. Adyen performs Know Your Customer (KYC) checks on the transfer instrument as required by payment industry regulations. Your Adyen contact will inform you of the status and results of the KYC checks.\n\nWhen the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-transferInstruments", "x-groupName" : "Transfer instruments", "x-sortIndex" : 8, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -3371,8 +3567,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3386,8 +3582,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3401,8 +3597,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3416,8 +3612,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3431,8 +3627,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3447,13 +3643,20 @@ }, "/transferInstruments/{id}" : { "delete" : { + "tags" : [ + "Transfer instruments" + ], "summary" : "Delete a transfer instrument", "description" : "Deletes a transfer instrument.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "delete-transferInstruments-id", "x-groupName" : "Transfer instruments", "x-sortIndex" : 11, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -3485,8 +3688,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3500,8 +3703,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3515,8 +3718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3530,8 +3733,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3545,8 +3748,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3559,13 +3762,20 @@ } }, "get" : { + "tags" : [ + "Transfer instruments" + ], "summary" : "Retrieve a transfer instrument.", "description" : "Returns a specific transfer instrument.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "get-transferInstruments-id", "x-groupName" : "Transfer instruments", "x-sortIndex" : 9, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -3597,8 +3807,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3612,8 +3822,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3627,8 +3837,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3642,8 +3852,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3657,8 +3867,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3671,13 +3881,20 @@ } }, "patch" : { + "tags" : [ + "Transfer instruments" + ], "summary" : "Update a transfer instrument.", "description" : "Updates a transfer instrument.", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "patch-transferInstruments-id", "x-groupName" : "Transfer instruments", "x-sortIndex" : 10, "security" : [ + { + "BasicAuth" : [ + ] + }, { "ApiKeyAuth" : [ ] @@ -3718,8 +3935,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3733,8 +3950,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3748,8 +3965,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3763,8 +3980,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3778,8 +3995,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3973,14 +4190,14 @@ }, "contentType" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is being deprecated.", "description" : "The file format.\n\n Possible values: **application/pdf**, **image/jpg**, **image/jpeg**, or **image/png**. ", "type" : "string" }, "filename" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is being deprecated.", "description" : "The name of the file including the file extension.", "type" : "string" @@ -3994,11 +4211,11 @@ "Authentication" : { "properties" : { "password" : { - "description" : "The password to be used for 3D Secure password-based authentication.", + "description" : "The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters.\n\n- Characters between **a-z**, **A-Z**, and **0-9**\n\n- Special characters: **äöüßÄÖÜ+-*/ç%()=?!~#'\",;:$&àùòâôûáúó**", "type" : "string" }, "phone" : { - "description" : "The phone number to be used for payment authentication.\n>Make sure to verify that the account holder owns the phone number.", + "description" : "The phone number where the one-time password (OTP) is sent.\n\nThis object must have:\n\n- A `type` set to **mobile**.\n\n- A `number` with a valid country code.\n\n- A `number` with more than 4 digits, excluding the country code.\n\n>Make sure to verify that the card user owns the phone number.", "$ref" : "#/components/schemas/Phone" } } @@ -4198,7 +4415,7 @@ "Card" : { "properties" : { "authentication" : { - "description" : "Authentication details for 3D Secure and SMS one-time password (OTP) for wallet activation.", + "description" : "Authentication details for 3D Secure and wallet activation.", "$ref" : "#/components/schemas/Authentication" }, "bin" : { @@ -4295,7 +4512,7 @@ "CardInfo" : { "properties" : { "authentication" : { - "description" : "Authentication details for 3D Secure and SMS one-time password (OTP) for wallet activation.", + "description" : "Authentication details for 3D Secure and wallet activation.", "$ref" : "#/components/schemas/Authentication" }, "brand" : { @@ -4396,9 +4613,9 @@ "properties" : { "attachment" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Use the `attachments` array instead.", - "description" : "This object will be deprecated soon. Use the `attachments` array instead.", + "description" : "Object that contains the document.", "$ref" : "#/components/schemas/Attachment" }, "attachments" : { @@ -4414,7 +4631,7 @@ }, "expiryDate" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is deprecated.", "description" : "The expiry date of the document, in YYYY-MM-DD format.", "type" : "string" @@ -4425,14 +4642,14 @@ }, "issuerCountry" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is deprecated.", "description" : "The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**.", "type" : "string" }, "issuerState" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is being deprecated.", "description" : "The state or province where the document was issued (AU only).", "type" : "string" @@ -4446,7 +4663,7 @@ "$ref" : "#/components/schemas/Entity" }, "type" : { - "description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **driversLicense**, **identityCard**, **nationalIdNumber**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.", + "description" : "The type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity `type`.\n\n* When providing ID numbers for individuals, the values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading documents:\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **identityCard**, **driversLicense**, **proofOfNationalIdNumber**, or **proofOfResidency**.\n\n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner).", "enum" : [ "bankStatement", "driversLicense", @@ -4518,14 +4735,14 @@ "properties" : { "expiryDate" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is deprecated.", "description" : "The expiry date of the document, in YYYY-MM-DD format.", "type" : "string" }, "issuerCountry" : { "deprecated" : true, - "x-deprecatedInVersion" : 1, + "x-deprecatedInVersion" : "1", "x-deprecatedMessage" : "Field is deprecated.", "description" : "The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**.", "type" : "string" @@ -4543,7 +4760,7 @@ "type" : "string" }, "type" : { - "description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **driversLicense**, **identityCard**, **nationalIdNumber**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**.\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.", + "description" : "The type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity `type`.\n\n* When providing ID numbers for individuals, the values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading documents:\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **identityCard**, **driversLicense**, **proofOfNationalIdNumber**, or **proofOfResidency**.\n\n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner).", "enum" : [ "bankStatement", "driversLicense", @@ -4554,7 +4771,6 @@ "proofOfNationalIdNumber", "proofOfResidency", "registrationDocument", - "ssn", "taxDocument" ], "type" : "string" @@ -5437,7 +5653,9 @@ "ecommerce", "moto", "pos", + "purchaseWithCashback", "recurring", + "token", "unknown" ], "type" : "string" @@ -5462,6 +5680,24 @@ "type" : "string" }, "type" : { + "x-enum" : [ + { + "description" : "The rule provides categories (such as country and MCC) where payments must be allowed.", + "value" : "allowList" + }, + { + "description" : "The rule provides categories (such as country and MCC) where payments must be blocked.", + "value" : "blockList" + }, + { + "description" : "The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.", + "value" : "velocity" + }, + { + "description" : "The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument.", + "value" : "maxUsage" + } + ], "description" : "The type of conditions provided in the rule.\n\nPossible values:\n * **allowList** - The rule provides categories (such as country and MCC) where payments must be allowed. \n * **blockList** - The rule provides categories (such as country and MCC) where payments must be blocked. \n * **maxUsage** - The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument. \n * **velocity** - The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.\n", "enum" : [ "allowList", @@ -5557,7 +5793,9 @@ "ecommerce", "moto", "pos", + "purchaseWithCashback", "recurring", + "token", "unknown" ], "type" : "string" @@ -5582,6 +5820,24 @@ "type" : "string" }, "type" : { + "x-enum" : [ + { + "description" : "The rule provides categories (such as country and MCC) where payments must be allowed.", + "value" : "allowList" + }, + { + "description" : "The rule provides categories (such as country and MCC) where payments must be blocked.", + "value" : "blockList" + }, + { + "description" : "The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.", + "value" : "velocity" + }, + { + "description" : "The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument.", + "value" : "maxUsage" + } + ], "description" : "The type of conditions provided in the rule.\n\nPossible values:\n * **allowList** - The rule provides categories (such as country and MCC) where payments must be allowed. \n * **blockList** - The rule provides categories (such as country and MCC) where payments must be blocked. \n * **maxUsage** - The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument. \n * **velocity** - The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.\n", "enum" : [ "allowList", @@ -5708,7 +5964,7 @@ } }, "examples" : { - "delete-transactionRules-transactionRuleId-success-200" : { + "delete-transactionRules-transactionRuleId-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully deleting a transaction rule", "value" : { @@ -5727,79 +5983,16 @@ "id" : "TR3227C223222B5CMDKQTBQ5M" } }, - "generic-400" : { - "summary" : "Response code - 400 Bad request", - "value" : { - "type" : "https://docs.adyen.com/errors/general/bad-request", - "title" : "Bad request", - "status" : 400, - "detail" : "Empty input which would have resulted in a null result.", - "errorCode" : "00_400" - } - }, - "generic-401" : { - "summary" : "Response code - 401 Unauthorized", - "value" : { - "type" : "https://docs.adyen.com/errors/security/unauthorized", - "title" : "Unauthorized", - "status" : 401, - "errorCode" : "00_401" - } - }, - "generic-403" : { - "summary" : "Response code - 403 Forbidden.", - "value" : { - "type" : "https://docs.adyen.com/errors/security/unauthorized", - "title" : "Forbidden", - "status" : 403, - "detail" : "Not the right permission to access this service.", - "errorCode" : "00_403" - } - }, - "generic-404" : { + "generic" : { "summary" : "Response code 404 - Not found", "value" : { - "type" : "https://docs.adyen.com/errors/security/unauthorized", - "title" : "Unauthorized", - "status" : 401, - "detail" : "Not the right permission to access this service.", - "errorCode" : "00_401" + "type" : "https://docs.adyen.com/errors/general/not-found", + "title" : "Not found", + "status" : 404, + "errorCode" : "00_404" } }, - "generic-422" : { - "summary" : "Response code - 422 Unprocessable Entity.", - "value" : { - "type" : "https://docs.adyen.com/errors/general/invalid-field-value", - "title" : "Invalid Payment Instrument information provided", - "status" : 422, - "detail" : "The balanceAccountId can only be changed when the status is Inactive or Requested", - "requestId" : "1W1UI15PLVGC9V8O", - "errorCode" : "30_031" - } - }, - "generic-500" : { - "summary" : "Response code - 500 Internal Server Error", - "value" : { - "type" : "https://docs.adyen.com/errors/general/internal", - "title" : "An internal error happened", - "status" : 500, - "detail" : "Unrecoverable error while trying to create payment instrument", - "requestId" : "1WAF555PLWNTLYOQ", - "errorCode" : "00_500" - } - }, - "generic-503" : { - "summary" : "Response code - 503 Internal Server Error", - "value" : { - "type" : "https://docs.adyen.com/errors/general/processing-error", - "title" : "Error processing request", - "status" : 500, - "detail" : "Error while determining the payment instrument workflow", - "requestId" : "1W1UHY5O2CONU4R7", - "errorCode" : "99_500" - } - }, - "get-accountHolders-id-balanceAccounts-success-200" : { + "get-accountHolders-id-balanceAccounts-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a list of balance accounts under an account holder", "value" : { @@ -5827,7 +6020,7 @@ "hasPrevious" : false } }, - "get-accountHolders-id-success-200" : { + "get-accountHolders-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving an account holder", "value" : { @@ -5851,7 +6044,7 @@ "status" : "Active" } }, - "get-balanceAccounts-id-paymentInstruments-success-200" : { + "get-balanceAccounts-id-paymentInstruments-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a list of payment instruments under a balance account", "value" : { @@ -5899,7 +6092,7 @@ ] } }, - "get-balanceAccounts-id-success-200" : { + "get-balanceAccounts-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a balance account", "value" : { @@ -5922,7 +6115,7 @@ "status" : "Active" } }, - "get-balancePlatforms-id-accountHolders-success-200" : { + "get-balancePlatforms-id-accountHolders-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a list of account holders under a balance platform", "value" : { @@ -5960,7 +6153,7 @@ "hasPrevious" : "false" } }, - "get-balancePlatforms-id-success-200" : { + "get-balancePlatforms-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a balance platform", "value" : { @@ -5968,7 +6161,7 @@ "status" : "Active" } }, - "get-paymentInstrumentGroups-id-success-200" : { + "get-paymentInstrumentGroups-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a payment instrument group", "value" : { @@ -5977,7 +6170,7 @@ "id" : "PG3227C223222B5CMD3FJFKGZ" } }, - "get-paymentInstrumentGroups-id-transactionRules-success-200" : { + "get-paymentInstrumentGroups-id-transactionRules-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a list of transaction rules applied to a payment instrument group", "value" : { @@ -6014,7 +6207,7 @@ ] } }, - "get-paymentInstruments-id-success-200" : { + "get-paymentInstruments-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a payment instrument", "value" : { @@ -6039,7 +6232,7 @@ "id" : "PI32272223222B5CMD3MQ3HXX" } }, - "get-paymentInstruments-id-transactionRules-success-200" : { + "get-paymentInstruments-id-transactionRules-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a list of transaction rules applied to a payment instrument", "value" : { @@ -6076,7 +6269,7 @@ ] } }, - "get-transactionRules-transactionRuleId-success-200" : { + "get-transactionRules-transactionRuleId-success" : { "summary" : "Response code - 200 OK", "description" : "Example response when retrieving a transaction rule", "value" : { @@ -6095,7 +6288,7 @@ } } }, - "patch-accountHolders-id-success-200" : { + "patch-accountHolders-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully updating the status of an account holder", "value" : { @@ -6126,7 +6319,7 @@ "status" : "Suspended" } }, - "patch-paymentInstruments-id-invalidData-422" : { + "patch-paymentInstruments-id-invalidData" : { "summary" : "Response code - 422 Unprocessable Entity", "description" : "Example response for a failed request to update the balance account ID", "value" : { @@ -6138,7 +6331,7 @@ "errorCode" : "30_031" } }, - "patch-paymentInstruments-id-success-200" : { + "patch-paymentInstruments-id-success" : { "summary" : "Response code - 200 OK", "description" : "Example respones for successfully updating the status of a payment instrument", "value" : { @@ -6176,7 +6369,7 @@ "status" : "Suspended" } }, - "patch-transactionRules-transactionRuleId-success-200" : { + "patch-transactionRules-transactionRuleId-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully updating the status of a transaction rule", "value" : { @@ -6222,7 +6415,7 @@ } } }, - "post-accountHolders-success-200" : { + "post-accountHolders-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully creating an account holder", "value" : { @@ -6254,7 +6447,7 @@ "description" : "S.Hopper - Main balance account" } }, - "post-balanceAccounts-success-200" : { + "post-balanceAccounts-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully creating a balance account", "value" : { @@ -6281,7 +6474,7 @@ "txVariant" : "mc" } }, - "post-paymentInstrumentGroups-success-200" : { + "post-paymentInstrumentGroups-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully creating a payment instrument group", "value" : { @@ -6344,7 +6537,7 @@ } } }, - "post-paymentInstruments-success-200" : { + "post-paymentInstruments-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully creating a virtual card", "value" : { @@ -6384,7 +6577,7 @@ "type" : "velocity" } }, - "post-transactionRules-success-200" : { + "post-transactionRules-success" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully creating a transaction rule", "value" : { @@ -6403,4 +6596,4 @@ } } } -} +} \ No newline at end of file diff --git a/json/BinLookupService-v40.json b/json/BinLookupService-v40.json index 3f9dfe1..cd92065 100644 --- a/json/BinLookupService-v40.json +++ b/json/BinLookupService-v40.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/BinLookup/v40" @@ -23,12 +23,25 @@ "paths" : { "/get3dsAvailability" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Checks 3D Secure availability.", "description" : "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys.\n\nFor more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-get3dsAvailability", "x-groupName" : "General", "x-sortIndex" : 0, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -48,8 +61,8 @@ "content" : { "application/json" : { "examples" : { - "get3dsAvailability-200" : { - "$ref" : "#/components/examples/post-get3dsAvailability-get3dsAvailability-200" + "get3dsAvailability" : { + "$ref" : "#/components/examples/post-get3dsAvailability-get3dsAvailability" } }, "schema" : { @@ -63,8 +76,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -119,11 +132,24 @@ }, "/getCostEstimate" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Gets a cost estimate.", "description" : "Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary.\n\nTo retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations).\n\n> Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", "operationId" : "post-getCostEstimate", "x-groupName" : "General", "x-sortIndex" : 0, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -155,17 +181,17 @@ "content" : { "application/json" : { "examples" : { - "getCostEstimate-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimate-200" + "getCostEstimate" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimate" }, - "getCostEstimateEncryptedCard-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard-200" + "getCostEstimateEncryptedCard" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard" }, - "getCostEstimateMinimal-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal-200" + "getCostEstimateMinimal" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal" }, - "getCostEstimateMinimal3DS-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS-200" + "getCostEstimateMinimal3DS" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS" } }, "schema" : { @@ -179,8 +205,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,6 +428,10 @@ "description" : "Directory Server (DS) identifier.", "type" : "string" }, + "fromSDKVersion" : { + "description" : "The version of the mobile 3D Secure 2 SDK. For the possible values, refer to the versions in [Adyen 3DS2 Android](https://github.com/Adyen/adyen-3ds2-android/releases) and [Adyen 3DS2 iOS](https://github.com/Adyen/adyen-3ds2-ios/releases).", + "type" : "string" + }, "publicKey" : { "description" : "Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key.", "format" : "byte", @@ -443,18 +473,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -589,7 +619,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -606,15 +636,6 @@ "cardNumber" : "4111111111111111" } }, - "post-get3dsAvailability-get3dsAvailability-200" : { - "summary" : "Example response for request 'get3dsAvailability'", - "value" : { - "threeDS1Supported" : "true", - "threeDS2CardRangeDetails" : [ - ], - "threeDS2supported" : "false" - } - }, "post-getCostEstimate-getCostEstimate" : { "summary" : "Estimate the transaction cost", "description" : "Example request to get the estimated cost of a transaction", @@ -637,17 +658,6 @@ "shopperInteraction" : "Ecommerce" } }, - "post-getCostEstimate-getCostEstimate-200" : { - "summary" : "Example response for request 'getCostEstimate'", - "value" : { - "costEstimateAmount" : { - "currency" : "EUR", - "value" : 12 - }, - "resultCode" : "Success", - "surchargeType" : "PASSTHROUGH" - } - }, "post-getCostEstimate-getCostEstimateEncryptedCard" : { "summary" : "Estimate the transaction cost using an encrypted card number", "description" : "Example request to get the estimated cost of a transaction", @@ -670,30 +680,7 @@ "shopperInteraction" : "Ecommerce" } }, - "post-getCostEstimate-getCostEstimateEncryptedCard-200" : { - "summary" : "Example response for request 'getCostEstimateEncryptedCard'", - "value" : { - "costEstimateAmount" : { - "currency" : "EUR", - "value" : 12 - }, - "resultCode" : "Success", - "surchargeType" : "PASSTHROUGH" - } - }, "post-getCostEstimate-getCostEstimateMinimal" : { - "summary" : "Estimate the transaction cost (minimal)", - "description" : "Example request to get the estimated cost of a transaction with minimum details", - "value" : { - "amount" : { - "value" : 1234, - "currency" : "EUR" - }, - "cardNumber" : "5101180000000007", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-getCostEstimate-getCostEstimateMinimal-200" : { "summary" : "Example response for request 'getCostEstimateMinimal'", "value" : { "costEstimateAmount" : { @@ -720,17 +707,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-getCostEstimate-getCostEstimateMinimal3DS-200" : { - "summary" : "Example response for request 'getCostEstimateMinimal3DS'", - "value" : { - "costEstimateAmount" : { - "currency" : "EUR", - "value" : 12 - }, - "resultCode" : "Success", - "surchargeType" : "PASSTHROUGH" - } - }, "post-getCostEstimate-getCostEstimateRecurringContract" : { "summary" : "Estimate the transaction cost (recurring contract)", "description" : "Example request to get the estimated cost of a recurring transaction", diff --git a/json/BinLookupService-v50.json b/json/BinLookupService-v50.json index 43c40f4..5562ee0 100644 --- a/json/BinLookupService-v50.json +++ b/json/BinLookupService-v50.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/BinLookup/v50" @@ -23,12 +23,25 @@ "paths" : { "/get3dsAvailability" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Checks 3D Secure availability.", "description" : "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys.\n\nFor more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "operationId" : "post-get3dsAvailability", "x-groupName" : "General", "x-sortIndex" : 0, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -48,8 +61,8 @@ "content" : { "application/json" : { "examples" : { - "get3dsAvailability-200" : { - "$ref" : "#/components/examples/post-get3dsAvailability-get3dsAvailability-200" + "get3dsAvailability" : { + "$ref" : "#/components/examples/post-get3dsAvailability-get3dsAvailability" } }, "schema" : { @@ -63,8 +76,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -119,11 +132,24 @@ }, "/getCostEstimate" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Gets a cost estimate.", "description" : "Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary.\n\nTo retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations).\n\n> Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", "operationId" : "post-getCostEstimate", "x-groupName" : "General", "x-sortIndex" : 0, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -155,17 +181,17 @@ "content" : { "application/json" : { "examples" : { - "getCostEstimate-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimate-200" + "getCostEstimate" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimate" }, - "getCostEstimateEncryptedCard-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard-200" + "getCostEstimateEncryptedCard" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateEncryptedCard" }, - "getCostEstimateMinimal-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal-200" + "getCostEstimateMinimal" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal" }, - "getCostEstimateMinimal3DS-200" : { - "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS-200" + "getCostEstimateMinimal3DS" : { + "$ref" : "#/components/examples/post-getCostEstimate-getCostEstimateMinimal3DS" } }, "schema" : { @@ -179,8 +205,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -410,6 +436,10 @@ "description" : "Directory Server (DS) identifier.", "type" : "string" }, + "fromSDKVersion" : { + "description" : "The version of the mobile 3D Secure 2 SDK. For the possible values, refer to the versions in [Adyen 3DS2 Android](https://github.com/Adyen/adyen-3ds2-android/releases) and [Adyen 3DS2 iOS](https://github.com/Adyen/adyen-3ds2-ios/releases).", + "type" : "string" + }, "publicKey" : { "description" : "Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key.", "format" : "byte", @@ -451,18 +481,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -475,7 +505,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -569,7 +599,7 @@ "ThreeDSAvailabilityResponse" : { "properties" : { "binDetails" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Bin Group Details", "$ref" : "#/components/schemas/BinDetail" }, @@ -610,7 +640,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -627,15 +657,6 @@ "cardNumber" : "4111111111111111" } }, - "post-get3dsAvailability-get3dsAvailability-200" : { - "summary" : "Example response for request 'get3dsAvailability'", - "value" : { - "threeDS1Supported" : "true", - "threeDS2CardRangeDetails" : [ - ], - "threeDS2supported" : "false" - } - }, "post-getCostEstimate-getCostEstimate" : { "summary" : "Estimate the transaction cost", "description" : "Example request to get the estimated cost of a transaction", @@ -658,17 +679,6 @@ "shopperInteraction" : "Ecommerce" } }, - "post-getCostEstimate-getCostEstimate-200" : { - "summary" : "Example response for request 'getCostEstimate'", - "value" : { - "costEstimateAmount" : { - "currency" : "EUR", - "value" : 12 - }, - "resultCode" : "Success", - "surchargeType" : "PASSTHROUGH" - } - }, "post-getCostEstimate-getCostEstimateEncryptedCard" : { "summary" : "Estimate the transaction cost using an encrypted card number", "description" : "Example request to get the estimated cost of a transaction", @@ -691,30 +701,7 @@ "shopperInteraction" : "Ecommerce" } }, - "post-getCostEstimate-getCostEstimateEncryptedCard-200" : { - "summary" : "Example response for request 'getCostEstimateEncryptedCard'", - "value" : { - "costEstimateAmount" : { - "currency" : "EUR", - "value" : 12 - }, - "resultCode" : "Success", - "surchargeType" : "PASSTHROUGH" - } - }, "post-getCostEstimate-getCostEstimateMinimal" : { - "summary" : "Estimate the transaction cost (minimal)", - "description" : "Example request to get the estimated cost of a transaction with minimum details", - "value" : { - "amount" : { - "value" : 1234, - "currency" : "EUR" - }, - "cardNumber" : "5101180000000007", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-getCostEstimate-getCostEstimateMinimal-200" : { "summary" : "Example response for request 'getCostEstimateMinimal'", "value" : { "costEstimateAmount" : { @@ -741,17 +728,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-getCostEstimate-getCostEstimateMinimal3DS-200" : { - "summary" : "Example response for request 'getCostEstimateMinimal3DS'", - "value" : { - "costEstimateAmount" : { - "currency" : "EUR", - "value" : 12 - }, - "resultCode" : "Success", - "surchargeType" : "PASSTHROUGH" - } - }, "post-getCostEstimate-getCostEstimateRecurringContract" : { "summary" : "Estimate the transaction cost (recurring contract)", "description" : "Example request to get the estimated cost of a recurring transaction", diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index d259377..3a8cbba 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1373,8 +1403,8 @@ "content" : { "application/json" : { "examples" : { - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1393,8 +1423,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1408,8 +1438,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1423,8 +1453,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1438,8 +1468,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1458,8 +1488,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1474,6 +1504,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1534,17 +1567,17 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" } }, "schema" : { @@ -1563,8 +1596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1578,8 +1611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1593,8 +1626,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1608,8 +1641,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1628,8 +1661,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1644,6 +1677,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1701,8 +1737,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1716,8 +1752,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1731,8 +1767,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1746,8 +1782,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1766,8 +1802,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1782,6 +1818,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1836,8 +1875,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1851,8 +1890,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1866,8 +1905,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1881,8 +1920,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1901,8 +1940,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1917,6 +1956,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -1990,8 +2032,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2005,8 +2047,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2020,8 +2062,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2035,8 +2077,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2055,8 +2097,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2071,6 +2113,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2144,8 +2189,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2159,8 +2204,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2174,8 +2219,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2189,8 +2234,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2209,8 +2254,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2225,6 +2270,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2298,8 +2346,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2313,8 +2361,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2328,8 +2376,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2343,8 +2391,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2363,8 +2411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2379,6 +2427,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2452,8 +2503,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2467,8 +2518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2482,8 +2533,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2497,8 +2548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2517,8 +2568,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2533,6 +2584,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2606,8 +2660,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2621,8 +2675,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2636,8 +2690,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2651,8 +2705,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2671,8 +2725,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2983,6 +3037,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3241,10 +3305,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3470,38 +3530,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3824,7 +3852,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -3853,7 +3881,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4166,7 +4194,7 @@ "$ref" : "#/components/schemas/Amount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4175,13 +4203,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4195,13 +4223,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4212,12 +4240,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4226,12 +4254,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4254,7 +4282,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4298,12 +4326,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4316,12 +4344,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4329,26 +4357,26 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4640,7 +4668,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -4696,7 +4724,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -4710,7 +4738,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -4850,7 +4878,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5569,16 +5597,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6214,7 +6232,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -6250,7 +6268,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -6328,7 +6346,7 @@ "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -6548,7 +6566,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6560,7 +6578,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6585,7 +6603,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -6594,8 +6612,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -6736,7 +6754,7 @@ "$ref" : "#/components/schemas/Amount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -6745,7 +6763,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -6760,7 +6778,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -6769,7 +6787,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -6783,34 +6801,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -6824,13 +6842,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -6841,7 +6859,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -6850,12 +6868,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7011,7 +7029,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7021,12 +7039,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -7066,12 +7084,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7084,12 +7102,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7097,19 +7115,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -7202,7 +7220,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7316,7 +7334,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7328,12 +7346,12 @@ "$ref" : "#/components/schemas/Amount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7341,7 +7359,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7356,7 +7374,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7369,7 +7387,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7383,28 +7401,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7418,13 +7436,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7435,7 +7453,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7444,12 +7462,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7486,7 +7504,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -7513,12 +7531,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7531,12 +7549,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7544,14 +7562,14 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, @@ -7560,7 +7578,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -7671,7 +7689,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7779,7 +7797,7 @@ "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -7879,6 +7897,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -8070,6 +8092,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -8596,7 +8629,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -8877,16 +8909,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -8895,35 +8918,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -8946,23 +8941,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -8974,20 +8952,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -8998,13 +8962,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -9015,16 +8972,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -9056,18 +9003,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -9091,2919 +9026,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -12619,610 +9648,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -13292,25 +9717,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.3.0" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "{"checkoutshopperBaseUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/","disableRecurringDetailUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/disableRecurringDetail","generationtime":"2021-04-08T14:13:09Z","initiationUrl":"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/services\/PaymentInitiation\/v1\/initiate?token=pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","origin":"https:\/\/www.yourwebsite.com","originKey":"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91cndlYnNpdGUuY29t.pupr33DCNDCi6ZWcCbuL1_kaz57Jh_Ibkm2mkBZP5gk","payment":{"amount":{"currency":"EUR","value":17408},"countryCode":"NL","reference":"shopper-reference-ekvL83","returnUrl":"https:\/\/www.yourshop.com\/checkout\/result","sessionValidity":"2021-04-08T15:13:09Z","shopperLocale":"hu-HU","shopperReference":"shopper-reference-LZfdWZ"},"paymentData":"Ab02b4c0!BQABAgCgt+NI0xLstN4SvHGzWhRqhw6PMY1WymPaPRkvmAZ1rk8qrsqC2Fp8V9r2Jy\/5kzJ1+jmP56FkJz2TqJG5MTt\/ksfRnH0ljyM5Mg1p0EbcOZ6sTy6ClUyO6zn9Ka3SPiE1fAkSe\/wUj4wfWvZHMcRM5Dy+w43IMRWH7htanbaeUOGW6YgudizbdueIHu57gApsyQuxOxOqmifBUCksVf4nEy5kvpv9\/qfb\/QeIiKefGnxNpcftaYIHDPuEA4K\/+kKf13vt1OZf1RspFc0qDXFRKkTYHrnbGJS0W6T0sPNwHiG5mG+40A1FxZWhgimUFQ7\/HcbZfHu5Mq9slUysZarI+FAekNL6O5xIhZxBGbIdW7ilSpcQosak2lKATmwSKk4fnheenwFRCf+lJErIdlqmkFAe+go1fJ0qxIdwQZO8z\/HdA\/jtOea17faE137ZoTprvnNwKOC1KRBxBSac12OVs8VVxKbPvFQKTDHPp7jzsTQlb9xF3cZ9KRWkzlJxFZ31u+c5ngezyC51JqurlH9VIweCY76vE9WZmBrj86xQ6mlEtBENFo+YSkGW7r8\/rZlLraMIt17fdIqcyQeBM\/aBiWIH0mp9ktsN5Hj1YrSf506SWjJDmp\/BZ3E1ZkuV+GgdJfpeIZAzja48UfvSxPwv01tK4dxIUOfi0l9OB3aEwhASQnCZbKJDc6rkkvxgdLp+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiff8fordfxJF3vxiYAd061rUEWVjkGNR0OpRcV8Qgk5dMNzGewODwBGBXzYiov4ledGZi4KCYpr4x6ujQ3Lgf\/r\/DThHVVS0juFM\/BDFgc35GL8tQ82CA3JgqQZx0f7TmZqohgPPgp3k\/2g5G\/vt0TIyFUOHw51wzO\/x66Bwgm++565WS06R8l+GLLw1Gl0Zknz0zsi0GGvgd6Y4\/8wlwZzyXdGpkhtW5G0Uxjj1ZyIUiYiD4AS\/SIHBx0LsI4yXkT22a8dutkyBnKUFfuoTGvGBacbPPfL1g7BU2He3Cqqag0Ab3qfOFuOaZ441Z0u9pc0x0xdc\/T3q8R0rmQHUoleHIg+V5bwEsNi3KLg5ZWX\/bvU6F5+\/\/ufB4zfe2eJV5QKJ\/wGEDSuxg1cYBX4PPLycL4a0tl4Wdjs015E5bBnOM5HDeDmdN4eR6tTGZj+P\/nVDQMBFP1oTFjy5SHAF4urQh8hpyRA992MwWkugGbpQCQc+YivS5pxH2JTqa8OsXFUn4Fc\/ZfbF40yphHxNfV980NwCwj0ZVabX+vd+2aOUHYqXIwmh\/2f16\/\/rYY6RJVePbSev\/\/\/rsAmGNTze3Rs5jOxcamoR0OEmRtytepBaEe\/nkNcCLsFhF2Tu7uhQPTSoUfMeDApT5se1zNMDU7rCruMR+M5DOSpX+W3SaRBYCyoeivN13dR5pk+uiQgExsyII6nykFhkJcM\/HKgMhBuCV6Uv8BhghySGS\/355yQpzfgxBi0ek403FWPBAw8ulf4KWrb50wasfivTTP\/KQyFklpQ1rX+35Eq9uOqOcTKm2xuvdqMRcVGbIIP2F+1mtBYX14tTkA49QNWLt5xuHSdzCQy4LCnzWruXrXdI3ZYdcF30ZPcdbpK1XFYpakYojiOk2QzSU2R45iqcQlFuxoMHxs+iL1n3vtOzyTNU1XZepkKk31IlJ3aTKKYhTfghDWJHm7JclenYgvObmZ5s5I36N4FDsocxAV5+c014Z49tH0etUAHEqTHpUd5YFbM7PQnLQgp43zTN7NUDwP9hrYKguRX\/b2WqruviyO4NZrKWJqtwmywnqT9NcjGP0+hJ9hVv86zhZuGjZNVyZGCj1p0r+tbHqufN9RxSchcM\/zTN0RDmffwU\/Z3gk\/qtjDFevIkki6TiYboLugnc6ZEs3gpo+gClgmHZ5dLuscwLU6EjCaiZoj12KBiRxTNPzEnOaRqK+YnWCKTamaMnD6SO5t1SLIi7Nf+uHkLygXrZ\/zZWh\/alF1niwmDp4NpZAO6efOC8Q\/ixahG6zzaGqNI5eUpKND2B+Uk45kOgJCffgPL8XHRGz88z1lc+wrnV35bw2kIiY5frf1vwSzjEFS1MQFZVrBDTmPkoq0VSGdja1LmP8htOYcYCAs3i2X9GxwOOycADCZjbWUikbwknWBSAf1lFrh39x5me78zOz0fSPOX\/d3C3pysK5u+zAMiPc2vL9nWFpG\/1K3s1xwaIgaS4i+BWvlO1i9iNEzqA1bocTU0q\/KX3wE9C08j8SrWsi6yjuzjFrU5syH3Gz8lHgsv4QTnmf8L4AQDR5kOjRWqQkArGPQ0E45pDaO5sK2ISxwgNIpuKtJ6+9MFM7vYGrHB9H3JomrZ8FEEjKKP8cUI2weIB9LsEpQJskMdKwMDdIi4dPgzvRaE2YxwHxJgtWGOd5YZTocHhaBYnr25dx8lKF91C4LohOzjzd1JCDJDsOmQ7FRZNsnz0s83tTFfjHcz\/ZBuaAPj0txCL7bHLfPrmziaGuf9wQ4vxqW0iAR5Cvmid+BVFJIz64Gww0GqThnHSyWRXYZeQ1DSG98orStea9gYEzqy8KWwrh\/rhSrDsC1bN+pZfZbslEYgB0riFML22owiGijw+n7dJZCyp2abifEocR260ffMxfKJQBvc5aPqGp+kA4na+l8GxHL\/+Yxn6SiSfgD5dVQ6+3nlhcGtBZBut04KRz7CSzQ0kEyL0T7MPG","paymentMethods":[{"configuration":{"canIgnoreCookies":"true"},"details":[{"items":[{"id":"1121","name":"Test Issuer"},{"id":"1154","name":"Test Issuer 5"},{"id":"1153","name":"Test Issuer 4"},{"id":"1152","name":"Test Issuer 3"},{"id":"1151","name":"Test Issuer 2"},{"id":"1162","name":"Test Issuer Cancelled"},{"id":"1161","name":"Test Issuer Pending"},{"id":"1160","name":"Test Issuer Refused"},{"id":"1159","name":"Test Issuer 10"},{"id":"1158","name":"Test Issuer 9"},{"id":"1157","name":"Test Issuer 8"},{"id":"1156","name":"Test Issuer 7"},{"id":"1155","name":"Test Issuer 6"}],"key":"idealIssuer","type":"select"}],"name":"iDEAL","paymentMethodData":"Ab02b4c0!BQABAgAQOXfyuJdcL0vN3gOePL4QWWQDWZd0LGPXi0C3mVF6yNIVtGxiUpdzI1UakkQbYHn8YL7Tr9UfSnGr11hvBzltGbnVP1Vusvasn8g\/En2dWWHdP8noxErAICPrypiG4VZ6rq\/b7GiTEuiWRLSXU0Fm7TmwbWfsU8xepTrdDLov+R7nUOXq9cZMZtsdEWDxZTS676VRvPPzOvmq+9VMZPKaqSOdFZQemZYJiTUGntTHtXT378jUWS3pv3V3BiyUy1OlgSNcfAejVFgpZtMFwS1Df6rwCi+uYvmj0+BhId3xLPFXI1pG2Tmpc491X0BnpCT25rESPdLZEGY6XAeUk4EbfBDSwjEfGkRd5coapUOPD1NlEYloW+drqGJSk8xz6a0Ikq\/nw7gVWUDqruWw6SPXMEfVAjGItHODnWdWXrjLTQuhu3BYrMy4xchwk1yKmJBnKsd\/mwg3px9zLZojAfE2KisG1X1Amy5jHMNnLEFAkywTqUMFcC8V5RSS3S8uMgBSnF5JCVKTQb+KC0KilRuq68UtlBk+jvzkTGcCQrOlq87MQWVbp\/6Mu7Ng4T29W4D1OXg8k9bp3BpNz+8jI6viUlwl8FR2PrumLZe4\/DhfnH1mHFgI0+7HCgNfYXcUdvICFkbiELQcP0PPsVXrs4I7aBo0mjeRW7cncuj7o1zvaRACy\/VCEXKEOZ10Uagna4YAAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbjsE3jTDdtjckWCfvwTDtha\/9AdnTpE6V\/TBqC19+bBUiFsW+3kRbX8jZRgbHbbI7\/YmA==","type":"ideal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"MasterCard","paymentMethodData":"Ab02b4c0!BQABAgCCognvnK3ydYPFoFKGKJEJleIkYbKAN3VVg5WXPNE1ud05KRqgsNVdvwuu9NEwpkb4UutL9KBUWA3feoTBBAWVJt1qpgZXF+JZOzfJ6BSc1a0zowCMQz6wtCI\/tWBxKxaKFaljAv30jga3+JCQkpU\/4gq2ubsNWcOWJWDFEvH15WN4gungZebQzS220kOfwyd6IS8TnwEWd5qg40rt0xD8xBaPoNYd5Cx\/C92i+6PtJzIX2SYBjGjG7dZmKno9RTXawhkjJmssEvFGgw9S9U+\/MYwKBel\/daKBTI1c+JIc4zqd523iev0YCruNLHv7pO4MTy0VXRwizCBURJZ8ZskCUbDM8FFPwxcel7CnF6ts4R0blmKKZCJr4VaX3uInfETy6x\/qUULaSatmFusDtePyQDzZA\/8c1jX3Uq896mnGi2nsK0DDeFzGmPA1rKEg77YGPtu2MRL+7\/9d5WOoqBzTe8h7Sp0uAP8mwx1ySXq9hdf8tkXrnB+yDP+DcBA0+sBNdx6PocBCaPfK4rwXZanRwFisZT2vrV1+e4iKdBAOExLm7\/mTlmhD8OpXugJkZuEY9K634aDcaNYB8aK1flD5J7y+eifQ0tuc18brADlJXIqpVx3uPQyA6BP1dNW\/nIFZBVnayz1lZXErLEDz899zB++kRFUKaqWAdGRUVU3DgRAppOX0EK6OiasLkA2YdsdkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZrwQHzXOXVvxGnqd5Cf75gjjoMkWzjgBSDVUu7iX12mv5VN1NNupVld4T5R40AiBQ==","type":"mc"},{"name":"PayPal","paymentMethodData":"Ab02b4c0!BQABAgCNokZKlG1MT3DDsUkmC0wuH87A3cCl2OZGQ8uu9Oc2na4sg1lYO19JLWqo83fNrq2L+9caG\/6t802SVQtD2ywXUeEU\/JifxXHbgD4zgC6I2XrJB2BrAVlfEu+Ni2Mkmty6R89owPoD4BH2BBgnb6pKYbgHJPP9qJj4TD\/oNst2sMkSXPNJv5v75ZhhJpkYM2MOO+eSgM901ssLWT9lj7ppbiavqoO8lpGDNHD\/IsJEqGvWhpIXrOFLMAx6FsS1xnTljouQv1kWYG\/p5esvpGenhWQkreUl3uYfv172B+3pRpCtHCL8qMflB+pdYKL5c9Sn3oTfCd3YtmINOtEMVcH8zew5VY6jr04yvc1x8sUYcdhovYfm8C3kGuDG+TEfuet7QFeRcBx\/zzv\/GIxsxqaJWA2mJEQNqjMbYrv1PzQLA44GcdgFI6xpT\/AwNoj5MALM6GYKs\/2\/0T1lYRh\/\/o3hLMx9R\/X5QuiufQa5zn2uZCyiNXEDaJ1bLNQ0gGQ3X+dkClEfidD1oxfau8uanfQ\/LZNsFWvWS9qaEyLSRBYEfQDDPMYujFy+C80PD51rDOG0nsppKLJ89kPR8M2F3OGE4PG2ENPOBtBHuYtnSYTUFFw3jSL3oZ+O+a3RBDlURp8QdtgZPYZHG6WBIb0AiN0WK1Xc+i3sZQ8s+nJrshBBRRBdkOu3rQvcuTX0wzkVrcOqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUnF2up7n17FMeYCgsWh5y7+HaUMslBb\/NQw7cuTFWeKoMv7CLTU4HNxt1bdkYHC00DSDxA=","type":"paypal"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"VISA","paymentMethodData":"Ab02b4c0!BQABAgBSuoz29NnQafIoNneRKy7zbb7IqZLX6ZV8vFZ3N8ZkrkcwfMrKsfHesG4Qeh8R87jaWboITvb7muraTbZSTFbULBnyIlKS8j7g7WnKuxoTF541aiEjRGcF8G+5mktPsM09wFcgEKMJuI8CbztrjGMirsa8LINAqqMlJwsvwJqMDmBjj6S+lEmq6dxGNIjBZsBeSqsihOfZ1UB4Jz\/Ne6gWwvhl5gEaege6mdDxs\/y\/g\/93Ml7XxwkGeedbh43LcLPg6lLPM1QV5NQ7Qt1vWAA9mw2m9ev95xitkZRNoMXgQuk\/M9kDwofWVkmfxUP8W8olKjjK0p4rQAEpT+ORT6RPkpNBpzVzvEgwFUpZr4XP+LCasjf177sLL3MoZUJ4fZ8QfXaPLaIq\/nY2FFESItOU1ZotNF\/EAsHt\/OHd0Zq9RSTLeSOfGMDgo\/itkS9dWrQOoEdYT\/7plVxnKo46eABC4cvTn4G1s6CdTJYgNXkA\/IcMc3maFvyyfzNcDGihF1VwpMpWEDg+I5is6FZBU6IKJHXVEERmuLSzi5OImCn4CWXKXXrM4+3U8+OtUQxN+pKBXvxaP1eh8VigtWmrn94MtvSWlrJOOFn178cV\/HqZNk\/COf4hqC8qilfpSzvkMteg59N0sLQ1hNV2FlLZQjw+PTzu\/f8onV8M8Euu5DRkexCsL6yXSFRqurrTdabb6j8NAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQRC+LRtIEHnt1T9Ayq9sA4kWH6yF\/z2vdEl6fMR\/uE2\/6SRXJvd5DqpPfhoLNBPeYjJ","type":"visa"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"American Express","paymentMethodData":"Ab02b4c0!BQABAgBEGvruCjCI0v7n7aiHYnRKwExtyMG\/Nu0gW1S9yqchaWGFbonc+h4sZf9dK60J6iSibKWhjuYolkUVx\/+GwSb\/vdZN20mJTlrXEEPAyQI4qMIb5QVKa\/WTVbZdeOp9kDhCbn8fBBN58Y\/Uk0TdHOH4wfz1rOYaferr7iucPJXZB8byagvbUFvzwpS8GzoDKrp6XNgbKkd0y5oEeE17Cl0d3fGgbCJk\/B5D\/kTYEuAzqGZUA0eKQOkZfcnc1J08aDNLK5GPNpNjZdy2oeYAmsLZY3Zube1orrk1GsVIT4J0BWA2fw\/TfGPzxMsJZc7SfmErZSyJEWpDZraRYFIXMZ+IT5gFYzORRkkMFyqhvoUCGTyK2jRZzk00XCjMZRke\/fCe5HX0gxDz8zBDWpCR6ekvfk6GKkKtaKAu5tcQjFICarRcX3wIPNYhxrtESiWtzTugjnH1ZM7FqacdrJ92crsb2u8f5uxPOSFNjJwprkXXIdiSYxCiJsz\/vMy+usvfw+vGCUtwDaBXzvWAf3yYvr6ZI8r3RxMRBFvFpnRHpMDhuVGkV+3S1HUWV8xExq7MuY4jEPlWTsvM\/eZyXmLg8O3MKvYioaqvUDa9kecB5aBAw6y8+lSWgGV1cHyPl2RiqUNXdrz6+fJ\/KmQ5x57CFgw4tiPoivUJ0uTS69F7TZQjohA1QzcXutAWtXzBglU99635AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZfDoLu\/zISKFsToh1bg0F8aRlRFGDHwqcUx7eum3yCLQD21cqfKmrTLyacrlo5aM4kt","type":"amex"},{"name":"SEPA Direct Debit","paymentMethodData":"Ab02b4c0!BQABAgCbwCT+JO8UEoxoBPrI+qyUS4vR5TT646v1MiN\/gUM4MVm7jekk7Wd0Hmrjk1\/NEg7NTAcpsfZDBOcMlQeuTeDsEaC4kBf3tqsttfw+qY6TbaFLCtgNIr5wJ3dm2TwVhFCYVMArwJ5zoBIsoONUWpSKR11DY6zE5vuDgtifNA0YiN6h6rzq8O9GuCrCqUJbu23PMejDHA0rHDOKyxyOmBXHRvUHhNR1\/Kwtrvx+fYANnAHgkznTH4ldSXcuaMVtZFqcpHZTiYpLv2ydiT14PzipiODpRGiXy0nO7b5N8Rs27nYxlgH\/tDcI4eF4jl981TPKlF+u6XEOGm4Ebyya\/BfTDp93rKRMxo6K\/LrfI9J4WaA2tEZo6eGNbRuKPpBlV3ASu7wpCfSSw2NjouVTCkfYt8+XeeJeIIYZ0p8AWjn4LTwarmSVZ7cYw9b9eCU4XX\/RrcNgoLFPXEr8w0McUF2n0GVWDM7Q5b9UtoZ36yk185LXmoMuy\/\/vaBIvE8m7Qlgo\/YROv9Uem6muLu4hZzW+V+WEKAmwGL0eJZCdjAeGWz6c0nty8PNMUv3pf7tTeYN1gsvQfqlij3ILsRLcw4kNYvElnGlCv8dgu3cxlz6DsnMuy\/EqKQMZAIoUCd6eF19I3NfvAo2j5MfrpSKS3QGLTP6TXKqgTNb6d8sVD8gRKhCDK4Av\/N0p2CHGN\/YG5xaBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWQL\/0ruABUrzlPtx5llC5MJp\/\/iChDPZ8r7lkIf4QbzPP+8ETdxbzNZU4vwKTmUjffpLdQA2aswKEtOzYM=","type":"sepadirectdebit"},{"name":"Paysafecard","paymentMethodData":"Ab02b4c0!BQABAgAIhU3xKBF8QbmAvj\/6ONqIvvCbMr98epy6\/KIV9u+yJz2pSj4PoMDLbJxV5PZ1Ykxaa9WjWvTnlZ9NgeB+eoO26MbmIoAsMw8knjay+FE0Pyg5Gj0JXo9Ibe+D513sf4qKB+wQPXfUEqkniitTi8o+jyhbB123rCAJWvbZfPOEKE1RE+FHSEZyVvJmHQPl5y8vWsCKBHjyDK5oLJjtxDfbdoPRrMc2ogNsGlfI\/qpIFW8HXNRKXpzCj+YF4vif8Zn6Z8Eb52rfNZI12xVG6hZnmox8BmMgmSnGkCwnY3O3CFpDTZlCbJo\/XWSGgEe3xeHk7PiZSAjPOVHpDDALRB\/wZVf7XzGYqKkiwtjnzqF8kGYy7XUduLeVF2z4C\/QzgF1DzqzIA7Lf3V+0UBWhpDqHJCrwkAWyTCaOXrqw7T66pT7MtZr5V3lGBUqHk8T\/hNwcuzg9wrx5eHse\/wdC1+2eVay3i0YWyikn\/rYt7z1iyTTIyz96IxxoyMIq0zyULkniylcCspd20\/XgNhbrRmdAt7qPmD9rH+Cp7abIXbbiAM4LWfn9yOWsOsALSDr2TGZDjsmMISCXzLHU+SDOrp2SiJRJ3NHNsTrdEbX8I6w7zTaviTsNMEAd0t9gbyb3kW1F2rqzJT\/UPeQb5MJQ\/wqGGYbIOe\/XGE9BKxQoluKLFhBv4haTKeq9Rr3VsuBtdUxoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifew63Hop++4N+AhTkkdsSKG980izIWOIBwRrfCIR6YloEnJY\/80hintVkjZcIzDoQYFnf\/zExjiwIQ==","type":"paysafecard"},{"name":"Bijenkorf Cadeaucard","paymentMethodData":"Ab02b4c0!BQABAgCpQPz5Zr3DETTfSmxZeO1skeivMnITjgMXOAmpc6OHdPt04Qs0PjkWF\/7+nfFXEyS6dhYw6aOGIFTcr7R2xav\/88lWDCUhP1G7TtUl87npuGEsmlaqS0Kasl6BD+s5HQ1rlplfffupDBlFj3rePozF449gWoGX+bNq1Vgeh7StI7XB17K\/FDqEYQi+N0NUEtJpCDottPouvo0KgKuED9r0RQjAb8k3nNEuAFxkLTCEfgrRYv7HPDil4dx2yqOhsbv6DXfq0k+JxIFIR6HscRXmggWx1yzou4O4OB5UepYBSlxoJMKqEQXFQxURkF9RI8gOyG++2KYLHHolZkqRImnxeSZ88yZ3zP1eLbaw96TmsXcSk2Sjg5qWEr8RpJuL9UaXEpaOLaqm6E0QMXkbw7A2945YMYTc51tIB8hjY4GOVsoVqkKz2c4Md6yziKlv4XcfI5cMic1rI9q3x+NTSnpNAEBY9XsfE3KV+5dcwIUvIBw4BGkH8Wg9+N\/WZFeRLDKgmFwZ8kkTYMKaax03oHLR5\/NyCBX6GiySwLOqm6QlHtTIVajskcW5qQO9gbz\/JWxBBBtyAdeThE1Qv\/09fZULNYPZ5CgTot0q32It2Jash\/jQGf0lKLDjqWu6Xc\/rPeFDk6M5b6k8NZqSj+fegHK6+NmyFMzaBLWK8uyeSzUCbxDHtI02OGPTOI40iSVTnQfjAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYEvni+wibC9so6deSW0g2CaF42cgtTYVc0woMUDCt0gSvKHfPkxEExT4rv2Pj6tBy5nTOrvmoI73RtR","type":"bijcadeaucard"},{"name":"Fonq Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA\/VmZkWktBF5weoHZawlAmhz9rivBPh3eF24ct7JDXb0uvbxZCJ6cweI0fTU+i4iyExCthFm7I6wxgRLrEznH6033kj9J+rr7d32BywPOxNq+dt3yG3lZN\/LfO11k\/HeMobXvxU3\/al4nszGTXyVMiLTgf84vzyCYZWifPx6pakWjMeHI0qTYF2cbUzsGsoob+AUIh8HBQ3cHs9eRVTUI1P9QAErzjYCNzFljjayFgG6iWuzq113TpuLuSoA3YHn09moZ\/AGu4HIUnTK4Cfp9fu5\/FMzFHzRxzf0jxcy8xrW3ClyHPttsHxytACCvCt39xyryiNcHnmnZGzvcOb+R8DLTG\/jXLe6KjQHfWl1WjrCOHr74PDBglYf1wvicYj88iqQLI6TEzJopctDxmWI4FEyfQw7DEZX\/LooqVUwYblRuV+k1qg2RVJ8y9NaJn4m4R3Ti\/5yc9Wq1OrvpYUbFMB56DuCBm63knV3sEEFJRSUtVti6uDLP5NA7cYM0NRWLjyxYBMiI\/r\/zWOEg+mLjspuO80gQeg6aC7PzfVY5bj2YGJVY6TmSmVdNZAipa9xzHH4RpB5R1Pf3cBT6+xchT6i3ZFVC8VY9+iCxxdpG4TYeqcLW6pVe9hHAe6vq97G8+F6Gghqxb7Z\/DlxIPRuu+D4lWa2mshpGNUTdbF4xuzhDxi3\/zjFAoR8jPpymbJQZoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVU7KkI531G4lKfLWRXWEry7pNzwCMfzANGS3PGZeYA+2n31DEhwavXsiPBvv3Sx31V4XCQiEEUNE0k=","type":"fonqgiftcard"},{"name":"Bank Transfer (NL)","paymentMethodData":"Ab02b4c0!BQABAgB51DuujA7vUd5HEKFbHqfqbOvXmmtjP4CdUi0JruTVYdcMSuKAATLdzyB3ayN6V5KrvUKitJV3ogvhNPtJ7gGBKB3idHBUb6v2iy+YEvuTb\/\/bJ04X3OxxI\/9f70qvVKtbSjpXhgmJrO1E0evJrIhml12sCVTaAL\/paykhzWFvHzMmUZV62KWOayWyiMEzcnndbG\/CkJ4OMe22ipfsuNr8TTEQwzmAMiSt77lDdeN+y0JiyQyLHfR+gV57FC5PDYgP3ylpso4W1VXCcGx6jRFTwHhb+gyJf7HqrWErYl83GietwukM6TB261cadT9NHbSfh4FCTDvL6twoRzhefGbRDuO5xvs569K\/e9VCSEnen1Fa7vZP04azaZ7mhfYUcL60CFoWgNkJt7NrFlmSO71BzpyvWwEJYFnhk8vLmjDd8UqitLyV2hrusnyK3ESHiE\/k0d5Cbil3CB3QEyhw4zC6WMzXIutTMvLaJyn13nR4SGWhObWomXkSvX9NKv8NrZwy2BXheRAyOHStD3QLBORrAiq9pEWPZF9wv+eBJFNmDHCXwK88nlKbFKV4WzTO4vGPbNVGrHyM9DVIRHt25neVZBYcDGIyVrUI9txBm3rL6QUqnt4ly+5gDFNLjhpFs26mkcex0++7VgpuzcS9WUOuiOIY5uBplYS1aPesyxW6uhAypRves0tGoyoUelhL0ZXbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOmKTlIMV4D9THzNGG1oMsJb6VRZpIiBiSEWovHLgIBa1wHI3H28jenqzyq5a+7rK5XpMhLpq1i0LLu","type":"bankTransfer_NL"},{"name":"Pathe Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhO2Q2JTyJ44bDAkSQQlkgI86+4Hz\/IMv3o8J2Xk9Ky\/Ckz0b68SDv35YholJFlJezRYrYWntzXfcjcfrv+HsRqej9Aieb8bGo1NrSSUa5FEpB\/aGXAP5Bn4ph2UzppDyACOOy97jlG6CPiZZZ2RPW9\/2SBP+Zwl3fzE4PyON4uM5piN+b9c9mQBlUZ5trTAgcOPBPhGpdesNqOklsHUYedp04B5RH4fyMDQTotP7WoHpbptMTPhLuuNn9rFRaIZrf4n+hnsiGa66KnGa\/MK0RKpwI5vgcY7TJt7Ym9lqwcnfjwYSW73hEeZj9J4r1nhTvc1p8SSnKN2wKCs+Tj4Bla+7pPzJjxpiNdeENOj+DVKAc4qh7lrGvLs\/eM6sTwrmk6k6bqD2VfC7yIlcQuWgwEDyU3BELkun+\/KBfwH7O9qC8YdEQ6ftHknq5qu7esOgmKUPrh0+0pO8QSnuzeObGcmVZsKZSWPK83W10XUtd\/Eb557f+E53C5wurfM6hlkaoLA9Xy4tuq3OyzJSn+U6f5jnYpWoPFbiU6FfPI594VjasrFZiaZ6pZFVvqe3z00sj7J3FEKtPDuABbgCoshdUeqkftUh6hNGcP9YieHtKEXxqiXFlk75yJ1qZeLvh4HeBJUqwctWgwyCirIBqMTI3icF31cdnwMYj9x6pnK56ahAAcSdzbZPYiLmLBmK2IDnwAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVSWDvE6KaKChC2HUEIlit8WNjy2vPU\/veo+SPjHQXporYlv409pRe+Ott+IgTXXbCtWN8G6oOrVI1ht","type":"pathegiftcard"},{"name":"VVV Giftcard","paymentMethodData":"Ab02b4c0!BQABAgA+A4idTs3qRa1aqP3B0gIqp1\/XQ+I4v6akD6AGmgH5smozPUK8f8UzFSBqwgq74fKmLWOj6S563FZHvcS2DdPKSATlh8bdG5htjyaFWkyHsuyga1\/fX5cE2FVFTNNoIsS5elKNHMDEXko1napgYprIJs0Gcugn8wFRZzbd+iVIePbiyQqlNdgdcrDOMncTEsRVR7COekfWBpmskzsVjFeG7h9LRqbtyGQ9py\/u51MUW1t5OL57vuxI5mE5QqdNEvIG+04QdIa7A+GuZTzLvnw6mDif5RZvD7BLpYmvSCBNCHJLh7JYxJantlkz6YqBf7cQjHBjZGLvEnDLJ9zEUDj6A1r9zIrPG+Ds42PyPPpskOZSURGZdyrXcDBrU5UToyEylRi\/gtnHMawdHnw3VIDmmTNWm4ma4XzQgJM0yd\/AhZkqLGUWnPeNqKMIhN\/ZOrql39QeB3aj39yAJ\/+XYiRFeAGK+o865GFONaw68JjO8q7OOPADwbDGUn24g3oTtFtbDtjbv\/l8rvkA1wc+DQomK6pezGf+P5hkKQgybaxG1ryfXyaMQbv1hojwVFRC8tWbVOy9bBqGmbZb3ue2jt7lcXOtx0xTswFXzB8C\/EoKZQ0H9Wi\/HgswZ4y3SxepNzD2utrehnbyWVtZ2uyyOM8X+qT9h+98W0V0vF6d7TTX2RB0vtmbGcwIpf6SXVn39CZEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifY0HazzPpi5jbgPfqO8hww7YnpWeRhSLkbwJPQ5hYZJXsXn1Ma8rnwpYYi8jfO1FJKBq0hid1zapJg==","type":"vvvgiftcard"},{"name":"Podium Card","paymentMethodData":"Ab02b4c0!BQABAgBzwaQU+Tg8IgY6LWZFZR765RW6ZQ2DZYU0DtHpL1P3XYk5TPwF7aG7Yb5nc6wFkt0kpUSyCFKNn0h+L61XtT+NoDCTTYCHfA9YtTwb34NY+YmZGdKeukR7TQJscKNPEFxzc7vdRXxJ0vTBuyXiLP27ms6db0e5BtAfgF7UlVHoBDhTBl0UZSK97b0CRrH3orO74z+H9UjeP141HR7za7ay9Jk9gXEtgFQxoEjacvjC+IuRu6MZ+rfrTiApkcFcnap95mwxYQdzPWkZH9ka2S9NFVSBTx1g1BmFopj7nNQBHnru8DXVxnF2THJjf9N9MElcFcKnMDf45szoYTQ6dW+0W+wTKcQEUL05yIaULsYTfqgFegKJtdHBadGgUZu6d53dCK6TH5gTxSmV8gxuOMFfJ1XKJcjJ\/WWFkgRA+9FJSd9vrGHxVP4ZXAEzt6SteJ8Ew76VvEOkAp9K3kASCLMrJDKifEV7t\/5VDQkPzg\/+EWScYpwtD0Y1HPziNaum4xEpHl\/Ivbr41ZVDSlgc3u3z0ET9VPz6sWP59oPY0pWy+45XyL5fia729tJCLxCPC6HxMTf9YR9DtneDA0fQWS8U3AS2sTiwYasVj9EPOY66YBqoF2A6127l08qV8OJaZS4enIvuVxtE9VGB9ZXVBB9t3GeSj+121B3fQpcvWbfavBCmqv9Z37f3YphvyLrb6gkEAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZqakCpG8Uf0AtkpxtcdUkLTz\/ij5cbS99cT58Cqwnjo0muipxwf1dRNtDIAaluVuyvM6IHNGfql","type":"podiumcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Maestro","paymentMethodData":"Ab02b4c0!BQABAgBqjbzap3VEI1UTDAV+YAxi67UHIAXoXAQYl9pQDP8PGTVnvd5WGD8MFgUPYUSz3zjLiRomZirNNwEdxns3glOLxnbasMe9cit5CbEmP9gZu4MMCouutZg2qhhrPBLewc\/RKJJPetKUjW2W5gHXEUcX1tdt63sg2Z8o5g3y5+WqH2NnoHAQN8DYXZ8W3jAcltX+Uz\/5hIhV224RorNAOM8tgTB6ADAM9mMfAU6YEHHB5ADVdM1IDtRbg45c4CdK0nIihZx\/kIcDW8aygpWMpPCuFjFpO4f0cAtXW05N8KA2VjUAqjt073Hzv09fXZjVV4rLo29NNP4qiVYIm1GRQa6jQGfyWfVzYRCp3BM07YN4ISP2rVNkRoe5c0Tae0JHb4pUJ3gzr6BOXEySl\/Q0rSPPEJtmHGEdtmgRKG9UWhiwQVBhvU6MDDEkdCbfAeSByT0yMwmFgqHZVV6e++2ZSOxiMj46mj7x1e\/Jl8v9OuP+YoqYlWqZkdC2Cccm3NB1+8vkuid\/sj+x9mmjHfx63oUZB0WkuRJvYcDrF6ije8C0TdcE4XWVOOc3jHsOSSq62d0pssHA0Q85YP2w2RiOuPrPI7nddvr8X2U8C\/UhO9jHff9\/3TcygwEEBZ8TPWJaFrDPzHVhMTMQdqcWsMCOguIsrWReIT+xytzNbv31WkhfyRBKTiRvzxvH\/sV4UlKUv4+4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdjiFWBHVC0eyVNBpmJjARVoFkvoNhGDK4dId7U+\/B8peVyQA4VYtDRvcwUea06G++wmYTq2","type":"maestro"},{"name":"Rituals Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBDd1AVaDRsad2eK38Kfjl+D+sqlb3Jhz4EhvuJXUFSv7cO0Q0vxYf2X81UR8if722Ts440VycfZaLlMzlCHnDhqeb5azij96SubBEZGYVdrpup2WLI5TrPBPJlDwcqbK\/AYbZjvSD2lFnJnrCu2D03q\/RE+CiXudWYMOPwPxA5uazZ8dlXXEmvh3KacG1wVwNUB93jK0tIFy4T97wrNPuBcgoEqpzumVZr7GVdu5ZsKZQsiDUHshopdhTZZvht0NEiCeE7dULsQw0uRh0+a6YHDsjGfB+cnfEhkYDr2BtoJvvsLRUIGs2ph2aW6szoFs0HP\/37YecNjQIKPSRN7XN+WCAxUlcFoYPbT9DXUXjHQMzmGCghy8FiuLc+abBHfw2GOv0nUQveBMSkyAaw9Ae0ViCTxCv8VmBLdlexnd7T8AA8frVZBFD9nA4BleNwkieZ8Jmlfv2XSUYb\/tVdovh5mueSd7sdfp\/zGwtjX+CQSW+NlSaKja+Lyn+RDhVUnIP+u6rV7+gdXLgfaAUqfFWi\/FunGZFiS1\/kM9YJrFbNnyEf2Rr2DscAtgVpyaEpy5ynUIaVXvYSxyNqilxX8MEayJkG2HE7617sy+9QQ9wR3um4K6bbeTaUlM\/TPrKTrsCMipFYevgFXMv57Ra4eLBzQKOIyMr8UpN+561af25XXxBQulOAgBXuMINjKZiYcCG8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdiOv0yNIw1pb7GKPw8hm4kjqLasknYB22lS1sjVFDm6RQ\/TkAi5N+4zlIbmeTFB6qENcBY6","type":"rituals"},{"name":"Hunkemoller Lingerie Card","paymentMethodData":"Ab02b4c0!BQABAgBOMjIh114zJyMJ3guhOub7m4v5km9d8vjTnuzgFZxUFngv9ioM0baZgjbHF1kitGBWUiWuffyLY6+NOXg5DRbxNZAIJbfW\/dxPkD8Vv49TuK7XKKXvaRpBpLiEVIzLlvqFC6KF5pohIpjioYTbK+VH9vzjGGzyyvG75QoXz1nZj2LmVrds83Gb5JjBxeBtqwROD\/0RvmS+wf3ybnoeh\/06SKaRAWz1W98PMe9AAvDT2s\/LFkPWjmFpGnWDK7mwKOWhIULLfnJZOD0pnb\/XorX3VPae8sJBEJdhuZgVXk+aox55WTAUpGKW+8UU+tHY1kda38Nn4ndRQh781os0v6edJ1EFxlFJp8cIcXeEf7kvuIoufCPiLf79DSHxJVCsEA2Sq7uKcTnlyaoz3uXWXp4JA6lQLfZKvlwrzcx04TdCXAO70Y8G1PSE7HMAV1bGLdf\/ce7Sys6VTGHDg+UZNLl4rY4PaGyvhrSbMBWjiolIKpfSnO+nn0U0JEbFLHRHCrM5ojth10+pLkSaaFGR+HBhKQ+uVaSzw6758\/yeV23TondUCl9uMETryEkpQvEN2OxgH0TBMnmB2R9ubwYjGY\/QytJZDnhwWBm9jbMJIoixEIArUiSZR2jSuq2pTtb3crGl8gnMDvz6yvY\/Wp7pWo8Ay62pB\/EfWw8yQkqCVisNehAcd2Pr2NCcmD7w2Ix4aIkKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXPaKLqHcQLV4IYHaD6ib2xySERpw3Mdd4CedXeAqGC8nKp0pPLQ46X4V3TZg5GLBcHk36UmFt1E","type":"hmlingerie"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","optional":true,"type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"UATP","paymentMethodData":"Ab02b4c0!BQABAgA+ir9YQzKM959cQ+mKHK\/ACCzf+epb7mwhJpeemAETLlPukrlz6cc8tv\/XEzHYcSDuBLD7quWFzkxWPTVI3q1XrexQk9bWgqV3GLdkzHnP0isR0JLEreivj6Z\/af\/q2IbbAd8c6v3Up2GLZgOPkEwiLytz0pmrbDgE+klCIoZ3vYKhNLJHDzAPaT5cyg5Rk5pjbZxz9x3WOajMut2HF5mQw2245mtaKYLT9SCcNCEOEB6PbRCLYYSGCvm0fE3tF1QsqptFoPReAx3U2NJw3ssOZ+C4W9H5qPR22s4HCvB40ZQIchux9O9x4TiQkD\/F8d055V51py3myBZyIXW3IHol483fYM2FsVs0PMkE+t4v++cKgQHw9I\/T4S4xpIxGhdxb\/Epz7i8QhxturHB\/3xFbr2JmktzFtLI27NJ7kdhfRE9WghQIMjmqulLBXc2iF63kuHKNyZGqsyr8OKS0mmGdWgyaR2GKEQvJh0kEBa4ZcbN5dWF7C+bba\/QGg59dAttGIEDXYM2aTI\/o8uKvPKyWrhtzkCmCtj0iMaDEKSiKVJVqfCQVVbgl8xyQXA8ChDbGo3TTPRgLUAWDllswkTfBfvbXtL8sNNUAa20zwo5xAMyw2gt0H8C3xnWBDy3jNmqVzEyeSe0xFvPXk7deYlKytZ6SUdUsbc83qaOqASv1NhBOL8ewqdnnYszv1JTDp8loAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffr6Kyg+U\/BHwUbzhvvBmSBEwlB5SD3xWgEq8rzCViQNW6TPdGagXycftIVUlnJ7Dmp+","type":"uatp"},{"name":"Primera Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBr+wD\/5Gyd\/QR5Gd3nQfdZ\/wpiiOWsTDw+AhVQV7IJwyxacuJmewIRy0O0O81MoVvRc6hb7vCTfETXbBclLTN2sxgwWMJEAAW468XQPi7oVNoI9xrn6f1cscY2frgc3L+zRA93sCADMPVK4VoJ2BHkTCOoDSXeFcc\/RhLBjn7Uo8tVohMsWGuvHvDT0GyDne2V9cQeJ\/8Kv2Wrc+2eO0vJYfspLRPvFF7DitCYRqPknDpREwvimweEm2vZbfZO2DGrBizZyGIep1HK35rVk8\/d5Ep88WoIt1IXlXoZODsyx5Z1NkN6RSlPQtZspLb5An2uxmDGd1eziUsFJJikbpn2EONJhJxGNfdJjMbvRA6qdE+1Kx6Dlk+s9EQ96Bg8Ho\/19Twxvcnhgb2xJyoC\/EkE6dEA\/nwQZbwyTOw74PeKgBFcbx1ZvcblarESRTc8R6JB1fuEoOKVKJeifkpoLU16dvLZ7YBQKnUKQmskcwQG1H4A0qn\/kq2ztY1JdI8haDVh2ZBQEJEHhMGXqeO4kX96W7y0auXb46NfGhRzLmu+82I9DUg13U\/MvatGfYiTd3KqlBHxgxvx3DOFKnE2NKeoxiyF6bPRZFKvDNhDXZFSF55f8Mgjwo9CD+WCF8YbM7GlRxHVq7STP3pFI8CSLScNaPp+YsezSo6\/6gJeOdmw3RD1CQXCaSJeywTMaC1\/mlaRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVgriUMVq7kjHCRe8bocfRBC4Ox6x2N0IFlO7PWaHuFYtIoTGvSa2zyXKIDP+WrqyPZ1s2Hj408pibGA3Il5Gw==","type":"primeracadeaucard"},{"name":"Fashioncheque","paymentMethodData":"Ab02b4c0!BQABAgBTwcz72WQ\/rWZS7SgH2Vn8g7rWbGC8hUIDzjU2RezIuYG+QZc7dRUdnWEarKjDsnnHwhj2+bFRC6dHaG4OcSbbQV3Umfw6DKYzAQG237U859Oeb8hv4sgi9bsZl019pZ1Lu6eNCficLEVFklBNG7zOcTth3OY2fzrE8WwtgAQy3MoncJwwDtU7nY\/kYV0ld1yggEDG2\/nsg8qK61wXqkvpUxWGHeCZqjivzFdA66PHPB05iTj0WlsRigIoHQ6Z3NAri6kKe9oaoj1wOVpZ3LScUcAo87w8CpbYvSROEOnlXfLvOQD5tBO8sJQo8oZ\/Pw8\/Xz0UuAn3G8My4vR6wgYs+5bkCYpnU0yF+4g8\/nUOs3V3IXb0ylgoXO4X17Mb6O9\/zfWxwNBXiVOUFWPkBA527y69lJ7s+P1xrdBFBTOnLsm2nrSNu0o+DKHYS+OXbK3niywYaEAp5viCBAbbvm2ueq3Wvz8t6lt6TnQx\/RFxE2YS7wKJEZqWeGyn54xwrgtFKkXwL41tUInvOy3DNIQ+QCGAwDt3bAqiVqpmyeu\/5d2w4wya22HXs2vc4M1BQ0nEOs2RgOQul7LYyz0iOm8IpkZLIrGuq5Fh9\/nyTeKalYCYs1yLk01qn5\/RTLSzJDEeKO3IpBUXt95xY04Riu22XzdS0LaGZXXsjTihOUVvrhDq8gRHzofaaaaN1Dig\/07XAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQbcBV13AySSRL7q9jEJ66VjBiy1pyPT7p+5rNS1f6nFrX2yxwUAuIrtfRkLo8msxea0hY6+GBy8ntAl","type":"fashioncheque"},{"name":"NETELLER","paymentMethodData":"Ab02b4c0!BQABAgCChzD1kgErFNDP4mOuRgJyNzV50gjQtREUn9li1iXE9EHo37JVkIbGJoWIArhh08dqFhUJ02+GUJ39M\/pvwgTm0NX2i\/EoWJ8MSV1oNY2imOd3\/vB1qZ278DwNf8L2mI0b33DZu6LQomKOX+9lt76RLbeQR6ub2CdDZtMI+k795cNCTqpBNeUjGF+03GVfq\/PmVVIGwTeRMxoXICK8bMdUMIK9lf7RQKeWBdtVdwsCE\/3Vxo55m\/BSNMV1TBx9Gb3DiW947mYUXFp8dTHrTVXubFGD1ps6uI75qRzkmbsk\/W7giZxW6h5\/m+ntyxzG5QVMbwHYWlxMLD84AxkG+++4snsbE\/m0\/EF1rLA9a+4C9AngtZMjLugMRGt8fwuzYbFQPY1mY7hxxJsh5DjY5AHPNSWUljSQXR3Wpa4\/67H8RZ75XiKIF7P+B+R5twWFx96AHtTd23pusLHnPYl0VoN9eOiA257ciLFPgeyx3\/RUpfmPllsGgy59+7Go4fCe2jAsAWjDQcVRMs6HyFFQ1B+GRQZetNPLCBpgKVThhiiOikevHsNQ3R1W1OIRfdPe5Jt8sZMNWo9N\/nG4yqb6m0Wrq2FXdecjc5PQDkua6VfokjR4ikjBQ1UPeYJo44f0obmLH9d6amH1yMM5A2nv930VLjPuOCvyj94otuZz6jiAPhCdNAEXB+8IP0clv4vQtIWoAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXOXG+\/p12zPuFSinBYaAl9PsoaBeSuADkiwhiK30SH0JmDstGNO3aHTYsorlFcraXafcoQuag==","type":"neteller"},{"name":"Adyen Voucher","paymentMethodData":"Ab02b4c0!BQABAgA4m3Fmy3uAkrABwPHO6ZuMqte1FwI2I46Gj7wYm6jAfz9CYWqYqAmiMdnjKlxjfYPBws\/eDmYwypyJzUmSuuQ0ABXtT0dF3Miip5GISHtTRPuY4PVc6rhd+faICXJq39e\/QI4sFwPg1k1xu6i3kiSZMG5qcOaUbCcmbo7sapxu2b0neAnLj7uoqJGt7wWArzEoJ1OY4qH8+D7f28Y2LFo8cEd2rva5DTBzTLP+tksXVpzqZW9pkOXT+e7ECLHc3ahwtqLmv3jJssBQi7uj2yDl64VoPaNfwhAOpEirY0dNenpOewqksAgdmvMVecekfiWPbeuM9cyrrAUzypnB2IfNmaIsRkRkmS\/UXRQclz+IT60QhoowIPlvGiZdoAbkh2O+6MKcSqhmddYLur0F+GTi3knseyff6r\/6Ovg6E8ZxUlGaR0gZ2b79Bf0INA3jYYZgWI\/mV0nTfMZ8QbWwanQFNP0BNyKe0i3qhdKgvapPHcMiVW2N8BQZk86umQTn72mZg5J\/D1D3rJ91TZbNqSSKKUdIcePlSpjd0hV9J+NUTWCpg3xOUyaAD3oZLBRsStmiFKEhFy3T0rw5m0a1A1fLENYq\/vg8cj5K8igql4PtLKfNVckEls9EvBLfW0vz00nqqXRoZMgmFh+Em1H2QHJpbEQvq1Co042ZFGx7wfZADBBhhyKK03Bxpag6b3csSQ6kAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQlEAX4IlhbcsGZk23cCI10LWUzOFL+evz7R23OxpQ97a248sf6C+osDDcCQu8Y5fQNRGSictAY55XdhLKNrS04=","type":"adyen_test_voucher"},{"name":"AliPay","paymentMethodData":"Ab02b4c0!BQABAgCf1auSGoTYhtg498bFc6haRU6NhnNLG1J3AxjfOfY8MQTk3r2R6Z4ApsTvCopJHVz\/SQzuanZGKuD9Eg\/1Ie45c4tVKgO1jlfBR1d9uMjKIXcSGpzt1Zbw1HRCdHfUKv9kgQFgdSm4PEQ9Xtob0Jr2tGjm0HWmEPFN01rseW8Q6wxvBbVk1RhJ74rwgmGGr7GZXw9zRPaiaqh6Tw5F93pILHz9MFi9R224925BjGeF5trdMM3guF2u+S9X+9YdFPx0E\/uioYPWL4iUqHb\/eqUMHL+Ul56z8ZIakje6Cne43bwAiv8n1XcXtiojd8pO4TAYEPEO3OFZId6g048gVzaBj3Z4NOaKpPa1hkricwbm0D66+349Xt+baHl0JOtPOR\/bQwRHWop7rALG\/hRjivbvrCpER8iEiKaPxNSZoae93Ue9btPL0VhnaWD0NpcxicHuvZbe9dKffnCRDwdb+oqKMKSrgSNGdkeaO+IoAPDhvZGD09WFGVdWFGwsm2reUVcOfeSkeAfiITI\/ZcFlXcV94JXvvYP47XgvDrTnubDVfwK60hfVLbzywzd1cV3+nf56ss3b7I782r8RXcF9GJyfNdlvI6NW7aeAwsBPHcQhHZiT+5VHXbbxyDd4qT4tN\/vcRXz+HP4qULTxg6wxIM4hztcW2X9aJFNhzFYNbvi1uRAgDu1+S5xChfsEqkutUHvVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffDrYa7tRXGfbYA6Ge161KN7sgVl2oNzl3HnXezyndspuFFgDrhoiHelB1iOfRNcojjlLYY=","type":"alipay"},{"configuration":{"merchantDisplayName":"Adyen Demo Shop","merchantIdentifier":"50"},"details":[{"key":"additionalData.applepay.token","type":"applePayToken"}],"name":"Apple Pay","paymentMethodData":"Ab02b4c0!BQABAgC0zYM5I3qqo5UGCO0s0MdIxxxd7b29RLo+dgUPNfEFEeolvX6qNqKBHPjX+bXZGskIJFxy9YWbQQSZkEAEqPydtGr7rvRr2MIekcs0Q9jazt62yAypML6Oraktk2w3JDPZuKjzHo\/Z+YYx+\/1ZHOlpWL\/rGB2cZXSO1ZSx5EQKgfTmwlS1NkFfgQzl8sQC1htidsIOZGw9xPWbmscNhpqEZCYlDOfEzRHElu6Y8g5D0yHOXX5TVwXetum+LM8CvClX+DEzp9miM\/0TMV7J+3XtUTA3xcPT\/+byDfygb52WGmiHlEma7rDGdlBQ5Zz7Tbb8YW5y2XNp7f6RZ3ZWy8MR+V+BbFhnbvRP3pSsslI92uiDgT1j8Hk7N9cWPBHmp9eOb+iYa1yFEe9BkadGdYiDTlSrWJSG8goTRFBKRj15d43EvnBu4BXADSh0fNEXykhCktcaolHuusbFAr2CV2D\/TA8V9FwvuNXGAgU5szzvG+jMCztRg7EFGElbAWPMYyENO1EjUpQQ3\/76jS8qXBej\/OK1WtmUoCO0pltPoOPaF+swtitwsF\/t6L7gAEbmufAEpmBc4uhAhfSjh7vhurbWpbsWkeMWT\/i+xAxX75WzCc4jLHEmTW0dDoWK65aHpFqNhc9DnJMDNApF4jy54\/qmzZhQMdv5ZkOJ\/eUcZWybsBD2yl6FzpkIlHBCE+ZZXvK4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUn8cdiUMVFJnCsfxIFvccbkVMDMBW4yRrz8Qb2XROpsA2iEH05CECs8gLQYfrZbxIkjAOxMzQ==","type":"applepay"},{"name":"Baby Gift Card","paymentMethodData":"Ab02b4c0!BQABAgCUrswZjd5pZD1KaDp6qqgZyn3\/U0SZj\/slMY3xnJoJV+2FyFKMW9sobzu85X7UGm455G1HAsbm8EyIFVshnlD1Sd5ImzSgVn5dvjVytMKuWmQotUFVoyhg0SaHX0ZF\/+ZbqR3xaEYQvhAZdMJ2zlAObRs6CwHKA6xYPQIgoEPVxBhGCK1XLkFWRm0Q9+sMj68\/sa9EKf\/+osl+3R4O2ZB\/4cM4p0jvOBD3FYEZaDGJbONomic58+i3Urf82LOaU\/VBIfGCOLY70JwUwoleAR8+tLSiJRLks9ujxgf26naSML3f9H6OmjjG1LMe2Nt2RZZyFyMkGt84ACJ7k\/q\/gudxWskc5a7ZjmgqO4mrBmRmy\/DZxcPcWavLS+m+8NXaPZken1i6L53mvb+BryRtIOCgM+AhGyUaPoXQOF4XbLqhNqTHRh6UjH4MPLYJrVoSiWSvRsv2J1268rFTHyCFzvqu9v4LCGiP7B45AFJnKphFb62kr6bk5vmdbpc\/S9WUwq2avCbU\/dGFyIyn5rdEammsfp2X+prIEBkMdpN1arErttEpMoCtpKwMqytrvgrDzRgK2iPWAWu5EXB076VJXQt4FZgvWVH77p\/d2ZB1nxCNNp5cUj9ITvLwugnVDqJVwdt3Ze7m46dOj8F+AJAX35t9WlGhmh3Meoiq6VJwCgUSEBCfaieS3oR9KDXDCJYZ2a5YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZ+JyZ7fnomDQmxQ9n8Ai8mE4Ud5mN8EwTSRGw3hkUzlflEBbmW6H0jk18hDxxxXoMoirYssuOCdtbE=","type":"babygiftcard"},{"name":"SEPA Bank Transfer","paymentMethodData":"Ab02b4c0!BQABAgBzYbCACvYN8F4OSxYlOtPC4ad4Ei7HCFdr0P2mSIdhX0Dl1ncNiKMZ6D7hynZq1IixoecALYJLKLynjW+GJOxzMzjLI+MA+7LwVWkCDP0iHnpLgJUzp2g4sOwr9TGZxz86VMzJ+LhfOU74tQnyF5QeFf1KT0vGRQGhYMLRsZ7ZMleWxglma8WDdFkakYzD4mLHmhYsKORTNC6wsBPUewd+NbZkEA++ajIcTdH4NWR088EyewAWij2WXxvvtE5Hzh7iEAqoCUNXcWeb0WkeHTYXOU3m7iXH8y18cxz\/ioTYmICcpG3tX8uvWmmhiZNFh0ZD8+pFcrWJAz5xmBHa3bCtLuf2Dra6NuD6DZ9i\/bIg8jBJ+Oxe7EVwIxuPMWJDI1evntEmreLWMS7ryEDHjwanCLNv1rzSypBlZIhiJy6WxlvjIjekqjFMbVJYnJNRoJolMSyOAm+qE2ftM\/e6ZmN3FfLlGLpqRIG7m0Q2J1muiJBv+A5FLAJ5G9gjVJvDE4iEI8pLbX42UlFmRMRAcCKNuVsilf8bW3a+Dx\/T2XuLdFE3jTs5KiQM89NVukVfIR0BJi\/YMZdGqQuXNxGA8YxbHz5T7XQfuCHgHsiaWvGfgn3X4ozTyddCfjguIJ0pOfDi3rUwjK2uH0eBwzTE7798AiVcjC52zUEtpZ6fDgKWRBCEudgGtV4Vzs+CPIpRNaY4AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOWG7Ib98uBx5r9C4Ki1MOyP6skIdgfqL0LR\/tMyQrnQjHGUVCNi\/tWuaF0ubq\/EGOUWRvN4dER4iQiHg4=","type":"bankTransfer_IBAN"},{"name":"Bloemen Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBYEjHQXHsPQ53zYpWNyDvC7SNlrLLaAhQpjEYQk8PPmdaazLV89dowf+a+xepP8tHOTUwzobDVj\/KU776tP57HmcE4gjsUikDXEfiV4\/CSmp6wszy+IKktTTQJ\/iztld7+uvlAtRw1mVPWofaA+B7faxcxduC1jZpi+Sx7ciKHQylGvUmSe9saoz+Z8VyyldP+K0RSzC2+Pw8CyKraL169mDUXW\/5FNNb4Ig8HRVSX\/5Lhi+xIckSNej3wWE5WBRcnzX0PUVKVK8iMO0RPVNmmBAu3egsDKf84F8YQJ08sYEupa1orFHzvVm9JkHzca1zjKD9nMA0rv4AKaglpy\/j85hPLBRMvBEXdJRk8FDojP4C7cXg4yxLz6YbqT5jOB4hd9E0xBfyRl6T6v7XV8vzXA\/XyMsQpH8F7q9kddAIobfNlxSrwqRmR63zPIXuXOudMinxlH5B3F3RHmG5s7Iux6wLE0vrfEJb7T46vn\/+ec6q6Xz\/ubFsE10ZffvIyEM45Nn4BvsgvnL+33zNryl3LEA7ZYCLczmtO16jkxPa5ef1ncYn6+nwPaytmABtJWV5LGAlnoCB8llP8lxDWFQmccCymO5C5KqT27Lirlwr2+9ea7mb2k2mpIqrkbA2oW06GXJ8vGrXHlZ4vRtxXiJM1SXNiU40tfjsY56dYTwh2ZRDooipnPrgBrgDtwnESO1YZAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVq4UMZnNJzezmTRqBzy+ZUCi\/kgQ8pLf\/wuWIkt+XYuYdBNjzZ4wgivSU5\/ixwXRr6OIqRmnfLVJQyQkwc=","type":"bloemengiftcard"},{"name":"Boekenbon Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhXa21F4rgq1PNi+V9vpr6buE7fMZ2vfXfklIHs9yLO0UwaEBLxDY1aLRDkrCoPX\/zixxQ0J+iM7WJMaRPj9Lo86q+oee4UJt1q3lc22KKlrOwWSsMAWQ4EvtFexyITl8jOqfSzstprJDMC6a6cmD\/Uuu1\/9u+EucT9hLzor7uTpvEB+qQdWhVOXkIbi3XgKuzHkZFZWC\/cXmeuvihyaFdS2E5N77AfElpwTUjjkSWdhuTT4YpEKvV7eGNcb4tknPkhtW7XNXBjOeFecLNJVRSPPs8zh25nibZ0LESEAxUVQI+Ix2aqT0\/YARhZsKWVkf7yW24eP5uLO+3XcmI8GBHyd7ysSDU5RkRBcieId7sBI1nLxmxgA\/4E0YRg3kcN0l\/ejyLKhndPshLpcbJsdQdupQtGj2wvK9iXk5PqxlgY8xmI73DrFI8Hj5KYq5BmT6C17J7Klu0olLa2tQPkq3y3jYgDc+UhuCjLESVt3rEe8LGdKyVg1NiJxJV2iF+wqONs6FJBMKh\/Dt8uMkt528lRWkcsPA0kC182YEYzjMFnWMs1NaSemtwEd2gOvNJbANxduIawfrXA+tmD5Vk6NnMcWfO22hlGu8Ov\/A2d1BrBa1210OPxWi5h36f4xOvCJZB1kZrF\/8LbwDNthGuIOUoFzX4s+h1jYGnG01K3unmaRAUMYsabp4L2sw5MU9ZtPpRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaO8DXOTDuEp12ZTJ17xsc8hPNMSd2fEMNY5K\/Bq2ZHktR+J1Sip6zl3AMAQJDedPMUNKhYJpRg=","type":"boekenbon"},{"name":"Cash-Ticket","paymentMethodData":"Ab02b4c0!BQABAgBsZiHDR0Gve3zcnmYtLxMOTZLS4VF3wWqCwdtspiwJYi954c0akftgKzKMMcXoFRXDPZpqJ1DeBbkZ5eKjZzRWnjliE8fjO0PBANuflbRoNwyHe+eVa+0rlve03uaZQp4VO66WjFLS\/YulZ1AJGGyhka3MVkhsE8AWdJeSADCTKFVJA8qC1lBJjaB\/eLA8EHerqPxHYpi4s+ykFMsfipRHP9pIk+5xULE+S6NtTmNVT9JWsD6F+hbDFm6BOtrUnEKx3FmlZSYMY4n9CT3paF0sH2pNqJ0PZ9QgIzO21pb9BhCBt+1rXjLNXp82kOzBI3YRVdRGCeSQ2Rp69ycAGhLikftZ1fwRITnrMfjtEhgdS1qbIiEsAhyB1GIBa09755Z199U4QINvMIhrFb49G1YOsPyBXMyzQHgEAUxY7L1H5CwLDo6skb2LzrseaoKXfF4BoqfESoFiRbnI\/OcD0nh6+jFswHIPXJcCRIhfPqu\/pvnHNs+TpWzJgwQTyPy1C2k3D0e5gH1I4gcn46xYpZ8IccL3U53CIIFFLaVwjn\/wUackQO++SixCiW2A0ot5tS+TVQs9w8QrVWKLLiqTSuErcmgyTi36Q0\/hwJc8YCuMzSEYiNxk2wxHTdlHG4\/W21a6EMp+SnCWQnotauR35c6nH7frYHw9x14\/UJ8RY6eG+xB4fN\/KW526zbNgJPLk4fAmAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifT8y+YkU4\/u8F9ki4mg7yPxc9sfwIjQ+eYihenv6i51RTsNjHTECoPrQzMH45WT6euh08tXFLEmE","type":"cashticket"},{"name":"Chasin Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAUCPrmfgcg1JzKH99DvGr8BkpD8H76IJa5X7CQlnRCC4ZWxLbr6sC7WQbYhQjZQ0lYdTMisYPl+8QjAEPr1N6OGsWSbofrBhc8oNe6Q5\/kaJkHW5JFqUgMjnun+jSDRNSyuLOdsPgOV9BcKOYwiehV7v8dvtmS3KW\/l0TMgwHEn4V6bixIsDkEPd7uNX5p9ubVmiKQW7qry4vXq+OFbbxIWuq\/L9FawvKcYbqFjgwgsdZlQ+Y5zmlaDSQ1hfV9Lfo44Ph3vXD7Evyt1PKrmrifi8hcDeKQfW66kBulfIxesI\/MS2C13Z8cD+WutVG0rbD0uc5cxttm89mjvZrBez9QqTLH3MBK31WD25UzXKRk8C25Jdb6iwxR5NTDrRFQwfBgtBdFSpv3jhd3\/LCj5ycPkVSNOKQUpiT0GIBNJ4f7uxY8+vTGfcSjF5jz4kqI8Xgr++1vFAKCN0KMqEoePGxPIeTszSCKZjptZioNxeR7uU0wvaH18iqZlUmKy5K8r00fZAkxC8aFZOuKSx7JDdzcx7Rbv+4fBiLrwFXLsN5Nuksm0WIQE7zi6J67SGXtlrXo\/bpnp1duZzJ43KmWZYljglXd\/l2usrIYC08dqEwc4DUHKHVfiYzZbzbW+JsakB5bU7iXkJyO0mQZ\/pC6fnVogb4bo8colc2fpM5OD5lnhRDeFz6l0F+msrFfX9vv24wkAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXSVD7Xq\/yT9JnfU4nQiMdrcf2pE45Hp0ed6hMf7e9Tg+uY\/f2i70QpL3dxpumUcnd9zDUWTOJc8ddqXfQ==","type":"chasingiftcard"},{"name":"ClickandBuy","paymentMethodData":"Ab02b4c0!BQABAgCpjBOy6+XhVNGcD3XQkmoZdhv9fam307qmGdDkdieV5c7BN+QZHV2XF8AzgRmmUwTtHGgCvxIA7iIaDihSypB5XjC9NFu1CDwFs5zfPS09kuiZxgQXm9anvVlUgDy7l001y+n4maQtgXhN5olaUMEQ93QWg2WKeLbAzbE1+hebus8bcjAcp300TfIwSD6pztJxjQfwRvNzLrhRgszRipi8ruiGMI206YxJUq5yjpV6cut8MgMfioh3\/\/PLoiVWoCjkrK0R3TjL36fRVwY4XNBslczfEUlHCTnM6jLjjCqyAmNHay3oLv93k\/UxaJoUo9iMzFm7gu+NM6V\/eruSvj28dypv+UN+4JAs1PIOeihxOQxI56Zv+jKTO8GKL2VDOeXkBNy0gQmm0B1+vyDUGSV5Imc\/Ykafk4qgXPXG0tz1LH1UHgu+bh9qr63zFpilRpiu8OkoMqHa8CkqyrYG+Au9Ql5Vfh3ZJS9RF9mu1llY2AvNdoue75rdglD6kJop2ng\/8PO8vUSt29Cdemamtct8zQXd5qwC5jukW3+93brD34tTdKdi9dlpQa\/Tcla9vwVwxEerqjiSKx\/grl+R6ojktZXT+tpo5Aeey85EmlM5L9\/CstOQDjA\/hU\/D+iixa8z8vlrGGUisSOn5Fqu3n85ib1KGW+RHNQAJu6u4ZRBCLhDUHY5qNmGJtD9K\/pvyP1fsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSFcmmFsCSPTa+2JtLxC3d9MEWXmttbt85uKKpUnwwo3MD1lgu30j46g51TaVETPNu63LZYeC94=","type":"clickandbuy"},{"name":"Costes Giftcard","paymentMethodData":"Ab02b4c0!BQABAgB5dh0e0SvTSdZSqNYMMXtGSsTlyg4chLnvV01NpL+W7I9Mz\/KgwXYe+LYuP2yGoM6TAzQacDclI3AAnXAQJi7+5ay\/j\/a0\/m9ViKjmMcsO5f8S3mlxVApyIp1lKQod1QRWdnfGi2jsbq2DQ2hOa2WnU5gOofDPN\/ObZBAhZK3FyABfJvQ+mHMQ3yzAV6UMxPKR8VRRVBr3qexpeNsaSnT46JpijJUU4B1FAJUsIzivvDSzBcXzBNI\/9EKQbA8wbLb8VGVwKBHun5rPB5jD1uCRjvt7d0XuA6hNZiJ8yMU8Zv4yDc\/YmTEStNzZmy+ZjSZOHWKOzoyCDjfICJn3RnvhWJJDNLfbZ\/9KQV8NcPm6Mpm0fCjf152UZ9YMp2nKhGZhnijz+XLGkzUfAokrJB9d+e2EmiMa4CRubW\/gwFrg0yWK3cUV6+FsJT0NyTKkhv5\/k5paDvp1GF3JvIwXPJzpUEkYTolCXBeld+2YNcdjvVEWC6+YC+XJofqSjs+EanKcoG2giz6QXv9ESYwIOLQC7TcxHhwvJu7n0qEPWWvKUdYnxW57ZZKyZeAlwlZ3l6nNwv7d2cvEwxWI\/MSf0dqgN0mvNJTxpEpDb7Uv88IdA1QHBzl8y5Rfn\/XT88yXj21BN2wvqAnvCoU22FgtK41Ti6HBsRRakXeaakmilJf0HxDWh+wexHnojtqXGWZgQZxlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQ6kqwSa+fIsdB1ujIQB3U3EgrGldRb622nuP5vCg9vZM5Md2djfmnYIK8poj1WQO4\/+ZpLTzxrPFYbk2Q==","type":"costesgiftcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"ExpressPay","paymentMethodData":"Ab02b4c0!BQABAgAlRhg2\/ZqSemwr8Ih+EPOdyII2d0Fqd+vxWEbnLhm8aTFGk5cJ7BXwBvNvp7+kSkK2+u61SeKzbYlwk8wZZeLW9ZnSvtFocxEHYriAwg0V6feWhMFlVNwvMwqZ\/649y+eA6KEX0eCxNJLJgGfzmgyX2IN3R7SEBzXoidFDI\/Bu9L1L0oTn3Yjq9zGjrgmlPBUV9CULM5bexH6atWZJoXvQdaUzEh6TOGGTY6myFl1UEVk5+tGP8imnzpAiN1NEGuAzRawNh4yhfkPpQ0Cjm2CNFCri4+A3x+23jXkRFSJtCsZIyl6AeXtbDdBEwnRk9XO0GCxqTwvoqMT1mIp8tr9w0VSiUQfO1YHrky\/N1DLjkWuAmuZkW8rkgO3XVhwrtclmH8+yVhj0Vo9NmrJIQ9I6Iqxco5+368N8plzUCseAlWMmihdlSjOJtQ2bhnBCJR2A+1KSYk92bAccae2WQMWU2cbKZxUIIO9IdvendoaLzXj\/OvpMw3H6OvSbzW+Z6BFK1izrNRilrUyPOG5yL\/bnmpHJt4ueoX22JvnYCQ4KOBa2Lj6EUFyQbZbyv16r5bTEqX8ksZqVpLnSHhvyx5kFcFm7h29\/+GzZ8i\/Zi+1W121GBt38+ZmmNTx4iwRRPQ7zcp238cPnxarzHOLpWHmr42VKrU8ra3wi9i2AoQhd0hAQ6gXAx5EsYBBos\/TzRTbOAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUtH0xd+yU6FqhdjryMG483NbCa8oLdhRm9Q9uNTwIBmqqaCWfAUrVW5+IIq37DYV30=","type":"cup"},{"name":"custom_settlement","paymentMethodData":"Ab02b4c0!BQABAgCT\/yAsGsICPsYIG7hiOwZ5D+b1O9G+K7GfQfbJrYmfFVPbjSqh\/XaKdZa+1mTi5BKwuUAV\/VlOPkPQ5yHLS9X6DqB8YqJVSeWEC6HsfX31\/ANJ7ZcL4HFhVq3RM6D0b\/V3iX4DoOQ8yHqPy\/bNHYxaiF43psUHdBjWsQyFVlkVhf4JhC4fJdPlOacag5twyZHDtWM8Qx802T3GFWUjJ6U04I0AigUBTMQH6BbkthtMnCXsoie5+vbWndD73v8luguHw\/5wh5ebwwsgmbVLzi0\/7OITS96hiAQqR2u8dBSBYKhX4G3zfJhmNJyp1g2z5BU7tJp\/IYU+LSDqkQJnmUeFhQGt2wAFIgFqjIqTrFDzYDXiwb2U2jygr8v2TzGbt\/hTTknv\/xVSAzU5DzADJs8\/nv7l0uP5XWAEFXfI7wuUHxBTySlIWPAH\/+uoyhu+QLfAT1jLW4srNTPgMnFlgiuSRVi\/KGPAlN4HO2O5bxWxUZ\/136Ak8El7\/BMzR8tjPRG7OUjZp+4ehhCXNeeBH\/OJ\/FykNuysKSklhbOE7Tg+N0pNZ\/fiEOgCh0OWam8FOrtLNO9LZ\/M3HJiFYnOT8jdHp9dvUIIZ9758N\/jG+EZrVwNL0bfH0thO+GhTKCPsfcO3J6rTYdOpW8zMijfLk+KCjVQxTD6oc27Ha23Nm6gfNhAPV\/w+Ptb9f4WcmQyqTuGFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR75XW+jn7EcYM0F6+owXDrbhi+60k1z1wlKr27vIyAzr8U91Jm14Q7EzlL9zrlbXd7OzeMVjbAOCdHxJa2MXA==","type":"custom_settlement"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Diners Club","paymentMethodData":"Ab02b4c0!BQABAgAo7InmjrgFwmA7lm1eSiENy0cDe92QK9eCftyZ0MRsSqugGYF0kNdG8LCw92FLceMnnljTGM5hhmlTnhUlBESSfbSOLf8d4ECCcc2W4gVCNoOxccHzoQOFnumjwK7\/Nw2F8gXIApCxRUCnzbZdPdXbwoJRaak5KOIkmgStEOBAoikvxvcckvOsP5K84tK6QlyavL7pXDSVIcwsiyKoxzW47wjC04ti7D+DkPqBb7pzhcx8Fu4c\/28AhXtinNMPLtDPjDFA4wkLHvVuUBTEiRy27x5wcDWbHOVEMnP5yqKmJuD7Msad09y9QxJPgn9u9SlbP83ZxPRNFD1jjx3z0ftrQ\/8Gu2e\/BQ1ib1ES1eR7nOG08r5aZ8LrkJMdbuxYK5EObCAv1LKaiJNN0EursZsq+0lLR3I6NdtvxlICrimCYS2pB2vNXohDF8Q6gfcFZgAp8fH7qVmMPnokuP4I947gbDTd\/gH\/sx5fxUVN9oRQWCmhN\/6y16wMCW9DV4vXvE1zUaTNDM4E1Exihr19UKyifA\/DrNKgfBE63SSav8nT1v3N46GZbR8XfXs0R6iad7nxgcrX978op4fRt2tt8wciszulAoDQp2xXCAFTcs39mBqBE28zh97wD2tv2ml4SjWU2HJfXwX0wYUAZdbc5M0e9a1RqLwM5blEx7veR5SaUxA0Z5dML95Lu0GjdnDyrTbQAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRjz1jnjq8n1nAh9RGubBrWwPJjLS7IhRac9SzrYauDeqPcken4Am0XpvzzJJ6O42bAUYmM=","type":"diners"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Discover","paymentMethodData":"Ab02b4c0!BQABAgBYFaiKDD9t3ppHHM12pcphfSfkzj5XQmBKyHFyTgXmRwgM5DCf5p\/qm83HJ0Rwv8++3VkytEGkW5ezjx7niA\/R7XRGPC4JFe5m9BkNUad4OJJKn38246IX5\/tCTC50aazjLDSRAYDfOFwjCK3iCy3jZdbHjsayq3Sxk0uektVCAfGvgOtgFRu\/qbKxfHYX5JhRhRD0kLHqoPy++r1qFoa9ZCAeItPwOOIiOh6y5sIS0egka\/z35JFIpmPgZA3T0F6C4+1\/33Lqf\/Imxxa1WbxxOK+hRFk9xKO8vWA+QLhsNKiGBDdwrrP1IBZu2\/3GRl4c4vTt\/aTfzBMsYEAEhxYKvdpm+HLv1uvY62FP9VzZc7+G6tLgzhELi3Ugk9b0cqW2QkQa3GjRc9oyCmlxpTg3aN3HW2WcDLNH5obGAeI\/KV320zNx6Dcp4QHfJqFhajbiH0kJpM0f14PJFqFIvkjryq\/3xx4rq4VWTvNYbsQfdkjmjxdpuZA2lVFbM7FWlfr6dujmw2\/k+Nc\/LNKocXLPMFqNsAE5sgnBCiaudtBhzMn\/Jqg11uuejX7PwuvhkH2IDe+C941niVbdJwATT5s+rc5MU0ve8lYbannglu7vLpa8Ay+dbViS5zyPTCYAYOhP4hUVPb4ISDJfMjaZ+7HHvTmBbp9+xGlrIOUshG8qkhA+h2IWHVsMFvPKmfBZSrlpAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZEDk1OhXuh02mODttzWBOOFbwWhn5U5VBlnQZ4pzEFgfDteYqOogaJ1hfiz5hC3ciAefezhAg==","type":"discover"},{"name":"eft_directdebit_CA","paymentMethodData":"Ab02b4c0!BQABAgACkXJYEWEQVGc1cvYHr\/PEToWbECDcX2D2SEXBnZpMLh9pCFet2Grp6Qm8BbRvR4o4eqXB2Fbf8dgp+PlOYeVpF2B1sKriv56YOW4+eJOx93BQuvFjhqcDAdnuA1WEd2c0p0VRzd92CLVEdAMeSJZf4+IenTJ1xqKgJUq8AEKB1N4F6LLKMHJzgnNKsimyLitKgW6DVprbambfKXL7jDNK0WrHo\/9OUBJ31eIXTFPWOV7COwv+22ZpRn+mnkRFmNP4OoO6LfgloHwMY4ZoVWrbFFt7UTDJw4HAwJaEiOMjH+prjEevGqKheo75HxpsmmwRic+P0DJkjh\/7LiNJuKAOQC3EafrRCnErTJ7lglYN2e2g06KsFTgPFI80mBm44\/5MDp2arnowl\/9kxyRuY2EOcVkmZkHtN+PCqdmHPdkKGG43IC8E2bMgBaKJzLr\/TL5oEB80fEw2MAd3IJMzn4Wec9Ihtp4goBH\/5svLh8MWGcqZZQH80VbdKJ40cWNqw7yscqttDHu8+DWERqpYpkV+vORLsZeFTAb3o5S\/9RHIzB02easuTBrVKHyVXdHmSH56J6Zj92Hqjz11ZWR8JVHkYW6DGqvS0nHI6iQfyr1gGOlSGAl8TZqr9tXm57lmSWc1PV37\/y2EW+xY\/PFWFx9rg6z+pZE+LiZpFGe+BKt5GhCOMWe2GSvn0bSAVwiQI4dCAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUDGPWwpG\/h8MJ8mwupRlOeOI6M86\/yxnR0wEHs0UxONfu6RZ805+qkbIM2J0P4I7gmdMlLPcnsCro4LatrBrF0=","type":"eft_directdebit_CA"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"eftpos_australia","paymentMethodData":"Ab02b4c0!BQABAgCvuSe+6o1SUzzcHzxwAVlkmC3SOJcaaj6IK3hGWSkfHMN7VTgEOJRSZefRN7PZMGF9BK2M\/\/wa7QZNERXeqPk\/DokBPZtA7Jir1ANKZB3Ls6EHKUMZvGviRVMt6yvg5RYkbP02\/CG90SYL1gZW66R7bB3o+7RM60\/+HCCIVMcgLmn3jIV\/D9DoL4lZ9Rdm\/FIVBXzxzhmXzx9FWGO+IjwzadF655idJkV9Fs\/nwE+nGyN8sM\/nYBzKMYYW1XxsvR8JYKqk1XbAbDf+euXRVNXiWmdNnTl5MPGXIwt\/D5CmVAZNPhcP179wX63QaC+3AG0eZhyn5Tm9sm3Rt9IMsnkexBYd9hSmSKp1nkq5mgK3R6QQJVs8yexWIndiseKpX6ejl24gp8iVHa4R3io1lBO2GbId\/EDhCzqjVspmT5089REa8DMC6HBVBnFROw26tt52NPDz5Ga752xSS2dV14gXDPpij\/qqXVkz\/rgESVzoBSvt2irWBr8tR8Xnl9XJOb\/M5MQcgfv4PlYeTCc\/iTPuj0e+GYzKOA7bsxmUrewVakmyUtWTAo0umEQn5ttzxl6Ro\/PYX6MlJ9TM9tVmPMIgV8pXg7sETJ5SZ1enW0FWbcuVq+UAkeHllhc0qnuYEXYQxChlsER8Eo3PNcLLGNHIBaMlSrxtHKx0ttsSmPMAuRBHV7wp6ZHBYoexL19bfn8gAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbcE2OmagQwrIkRbuPym64f+o\/YlUEAjA9iyzKP9zwogk+kpCbBuJ966fwwr3DOkqOQG5j9IojoMnyfGrTn\/","type":"eftpos_australia"},{"name":"Nationale Entertainment Card","paymentMethodData":"Ab02b4c0!BQABAgCjeMTCCWbyHkLqIzi6WhOIs0cfGy8ohqynOFAchP5uknx5zoGGlmnn1yNW1wootHnZoQ+DC2FGnBcok++A6EK9tpAPzDj2a15ZmCjxV\/SkQVnywWvRfL49xQsq0vfQSYKu07PVMT2Y0GWilXW5LCJEoV9Nj0AAaO05iTTwuuI\/LiBYwSLcJY0Gy\/nQoVCGmi0HRBS\/lgFzlZb5JH3f77SbbBDkHGuQzK6XR8qxGP5lU07G4pwJ2rlBHddEYTtemdJVS2j7SU\/5auXz0PCkgsgAV7CoHNbclYsL6FF9ZRJbWyDO1QpodnY6ySo3MqSuhSR+v2sJxqIYS6MNwiYbJPJj9Lnf7ZY158z1v9YfM+XLZEB1gt0Pu8TqSTJr1509zavS+5wefj2nm5HFW98Dho3dXJ9p76OT6N44+j5yn5B5bGuhSainoQkIEJwc5JM3Wiu1ZVgNLYT3wMqHyIEVArQh8hZlISVuZphxnUj6w90IVBnUo3cMUCLegjeFoBZEYHi0j9mGqMVgyTL5bi3wPH7nhIYuXk+LZlCcGPPMWbyr5ebLTPM4F2aDNdFZ6WtXkBVOZT37P27nNFXVw3ZY1T6ZhHV4\/NipJqWUTQwJ7bkf9qAym7aoZc7AyoyTKM6yDF42xKK7xU+FgNEolMBJSofshvnlbSsj0Fm\/PRD0NxGulBBiNC+IiUig22Rsx\/VYfF9mAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRG\/RN0dnQzhDj7uZ2fEMdkGldletkPTAybC8wYB6LLM45oVYPELjZX7YUjBzaoZ+cxKhMqGOfm+s+xh4pM=","type":"entertainmentcard"},{"name":"Expert Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgCTszJcLXT+uJxGttigZblCmXk1gAX20z37AeDCztrSgfBe1Aqnik7RXJPua6aFQhmwOdeeffC51Q54RTppmkaFAYn2+j7SDko0dSRbIvbh7n2do3rYWF+TYDtoa0Ebfbg+sbbjgJ8yXtv\/OohsN4uR3eUQWaDYkv7QjX3jDP4h\/V2QhvRYzOf9CY0qWx9rFmMyG97+Ck5vltpQHXAAjFaEZUAjJ9G4grUuWByViFBtfqcauN7a\/uZ2yaf11giCm96Yju27Je8whJiKgkq3jq1HrEx7nx1nqF6vS1z5JqypRsvXZpw2o6Aw7l9N5KSX5GEK+DGtf\/5o2X\/OPzakj7JqRIBd4\/czCVDpX2d1rh1F8USTEBOyTmAmJHMldg4PaVPTJnOQkXZQLEQU0fR058QDmUKQ5X6sO\/ssL6uK4HxP9iNrYl9ZjERiFwEYdJI3NZq8Kf5mcKtlgxYBSZvwlud2WDv5NNT\/OlRRrCJ8DfO8oykgRArtCO1gaFdhguaT9qWj+2l84JhrldUVdJbTgZtPzdC+RaMkxsEKENWIaPFSr7J8xyqj6sI9KO4Z0v8qtp0Xndy\/3LfEFJW7d94iEbg1vfJhDrp+rDDxbN1ufswcvELiv31DuBPyj3zYCDdruuGtfBa06jCR5Zed\/xdDqQEYzFTvw+mKVx30D67l0Pnx6hDHUvryfFE+T8FuaEkViKnXAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVmg8HpFTq3+PEOZ0boCkxR5E4l3XlAHYC7o2QP\/gU+cOf\/RLlNEd3pwMgpFrA+qq+LCSa71oCs6WKAd1w==","type":"expertgiftcard"},{"name":"FijnCadeau","paymentMethodData":"Ab02b4c0!BQABAgCyjxcgXJ20YmmZzakseod5p2QVS\/6zXRowLF1QOY8MLodRhKc\/tKFwqfUNmdsNe4OnZgoUZnUzqadPdnqGy1ermdQfv2Rfb5ZNttW4WvC6aVxFlTlCOFWM9UtWgH0O3sIc56Pwu3oCoi4F95rUq5IjTk8HuDV+CJPWjKVME\/1r6WgKTDK3CgIRlQ5pJ9gW1Jr44oGendVJXXX7bgvZAw4FXukcEytJdeFw9vW4BU\/mwYYRwhLx4ryq7NDTFTEtLQa9JMEtUl+BaLSgynKr+ChnH3CzrZHidRGv+oP2naYHDAMd4HGjq5+mjsHeuzM2mdAq9CQ7qWFBJRemYIpJ0k+9dCA9IAquQCCLn0tbdRO2L7m\/k0K1NxDttxBKWD8ZnM5tayyf393Thu4sVMaRKyqhnlYtyDikzAr20hCXQImmLmD0eZeQBJGqXzUCGm49byy0sXgDnvZ9V8PUXzWPFUDjca4g2FBrmwx3PZQKnyNxwr+YrrQTcwE6wNZDLb82v5Y0Msnw1vXENZHMyZ5MmiPG\/+cBGLmnr4\/X1YtOyz6ZCcS9I5qhJqohrRtxN+WyEwCeljjxydpF3iJA1wPeqT\/UIAq8OojvB0Uqo52opFDwExq7c87BBeQAGFVqd0FW4MV9ck8Rp3sAm4aQY2D5xanUoDtEI+2XnjG0w6Vh9wRMiBC9vi0Yly6XkwKihOxep5PNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYs7Vz2paAGqPnXyXBtOMrU96V8rY+5icpFu1YXSvneWrazsOO3N+y3WudVeU9mQFVBlSFG1Uf6p","type":"fijncadeau"},{"name":"Fleurop Bloemenbon","paymentMethodData":"Ab02b4c0!BQABAgBXZOsuynZasy3ejqMVaJHj7rBBmxTdB+1QljXleun\/eQHtLB2w+r\/MOqEboTzAdLrYu\/gCLuWS2O7jI3+4ZevHWmx3KA0pNNZ9q1CNM6tLHwQ0nsGwDM1buTG+g5tRULY13M44YZU9o0QWnwlbm\/DmxAYtyAKIufwD\/TuXHVOhs+lj+UWcamJpnLJ3OqwgXuHwBWkwZ9ARn1\/sBAlVKYY\/Po82mKrmaly7Go9pJR2pS2ENvV6jYTSicPP6NI6tYnuddgk3T\/APxohNK+qcrx7La3riSRl92kK59\/7irgcuEqcEZEWX0zzlrjxPzzwlxS2PxRRzltnKyDLs6hz9PPtT9rZgiYyh\/VnPzIFxQklf+iqc7amV5WjiDOhKz2J\/tpYKMCLcbyIsKU\/TmLFORiurCwU5MtLWaIUG+MqulDKPNlGtwt9jYLWokXNHxTuWsff1M3FKJc3ofqtrbSChr07SoEX9aZDa1m8e91O6MA0qOsR2GbUsDUHdZyXOx7\/V0pesmC2UGjGZByJx6dCMeF0Fvf822YZL1otxGRLB4HLgSkXXSKv1XFN9GsX6dFarF6iO2SPhkcVJLUgdVmWvh6iQHD+5rw4E9dUNsxWgscCrO3+CUoZshg13yrCaNFD4nzHNtz+Zf01s0PawpD8ZwSjq1NrCvCbmiFrFiYEtiB3d4RAnrZSlH5YDLXTgqosLfWT3AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbOO2439Q9BfQ3ByJJMSwrJDvT6Sy1M+0bSVhmsqr6Rs+TmOr5pAZ3F11J+22AO0aSk4sLHTWO+GpqIMQP3oGg==","type":"fleuropbloemenbon"},{"name":"Gall & Gall","paymentMethodData":"Ab02b4c0!BQABAgAg7QkV+4kn1vULBkb4lRhi7bw0dRiZidC4vqbaHqkPPi1obPM6TJu\/twpWYhMLYppfvscQ56oUQThyN07N7\/lbwZGgoV6tgFtd7ZBtrgqJPPoVM8sdLBmRLC6nBU3d3U7Xu4SvtlX2JQmxj6t4g0zcgUqNhaLlMjxQ5cnMmbWz0hZ0ustLX1biM5gk7FGDW5\/e73vNgb\/rAkfQRPBWfbGLEC+n0+QBalDuSeVZs3XNdAp58mhchviEmIppKQMP5c+ZsCLyeqGYM9ROAv6QUbtXUKFihruXQDLkqPJABIReTpujZFxqV0N7mMyJbEeh7ikSXKqjQmqqtVZt+wciVz5kcWR1k27K\/3WV1Vy9HNT3Pr5Dda6u0KKm\/G6lf1oj05yaozEJhJkgdrJ8lrSe10oFfCEroNoj7bSx4xBoA8IKZ1F7jqzbRRCgbFak2OBgbOo155Hc3mQAxtgZ9teycjMfKAjo3xblhQuqObQURMp33pbvlCL+3ToUifz5ehydevrHLDYZK\/AA7sv44AiJAy6W+mgfFifXJM3+XasVBNz\/oto\/stjymaFMVVXEqpaYiWOKsOmoyqNk5mHMM5ZFFrfz8lFwojkkjOlQWCI6d8+PeRlGp9dW8wmKOvFJG+RpPmYj3c1SwdGT0pevQo91hZBB46Ypn5KXyvSg\/t4vatLrvRBaXqwwvCMKwYwTA\/HlsYSUAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW\/eRKmjw8uoaWKOBol+hsc8L\/WyVZIIi3NlOa2q0DCbXCje31jkFLJqHJ3ls3mBT\/A6ew==","type":"gallgall"},{"name":"Generic GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBHMmxoZXymjsUwaJug\/qfoTG4VC5Fm1vVTvBgFQDsUodpLkylC+O1zyY3Zu\/MhuDQMpm2mSImemAUeBq16uSlEBnJx+oQEdM7sy0DTfXGTaGqpO0MEzP9bBLdHVKvy9IeMXRJKkjTuOStL9BN1z4EOuSJqD9zEENPMBJ254lEMFXCu\/sUQBhYH4Z0qJZRwjtd6AdB1Uc8\/qwGbmntKUHx+Bxjk\/AKKHrmdFlVJ\/2fjavkqJRIc5AuCjwpnDZ\/zUqx4pDHmG\/Y3UItCCFmSZKFFTsPN9\/IFMkYhfKxipzv96eHMJXV7OAdEVhplHHW57gqENbAOcKvgTBzvtxokLtZTIQZNM45yHDBlkXN96T0fU4ZhdI8VmFkTk0kKWtked4o5BxhRhf9YsrG5sby\/XNMCGbXubTlrhdmsg74qSt82GHXyyMK7+1qFI\/WQzMDHcW\/grSllUvBR89MujwbHUrjVgS4Q\/qQNSFet07d53UY3maMspxdpjenYVP\/6OyMcE0SQnR1ZXNHm9OA+TA7NR0IIEFEG4XtdzhuDc8acW2GlEvSxsTWL44IaBY6PRilpdF8U5CJHkPEWC4criLpxeOpkX2ulgdc1WsFSwEJkzZRGdq4WYWkrWaLfVwj9Ihc3ftK2sb9928VKmDMg97gc52T3fh2NSv2uVRZGT4Ay\/wEpnBC8Ev\/q\/COqfzFp9HHO2Wq5AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeuy3dD8N58\/UWJfGCXfFvHmQFj8EV+Ams+QEs4c+dTUH1uLGiS6azxtNi0sZ1numoBF1FsBaTM4VDvsWxI=","type":"genericgiftcard"},{"name":"GiftFor2","paymentMethodData":"Ab02b4c0!BQABAgAVPfvRFY9o0RRAtb+F8c2kYHb+aOlojLUI\/ta\/6uB5W+Y6yFF9vCHY69AhGB32kH6EHHO8bv985AJyaRwgDs4QyzofNDevaz7zDb4ET3Ak+Q3sU2ObO7wTO8TAP+YCTOKgJ3jZaEKt+ExzCC8646uTWRuWQ\/TB7j2p5x4MEt1Gb3k2ehc8608r8oLywYiIQIx1XyuvfRVDHttWcNj+Lza1tRr2QTThFdLRa\/wNfuJPw1\/AYFk7HUzhh4AA89dQzSRYHs+3cglU0VdMvm3NEgvXYpYyNJGhbCfujfUgzX1ZfjHhy1mQP5sySPm5hXxjvF\/6deSM+HaSSZGw1+f5N36sVcrMNYPKMYlh5c6zy2KzdIIhxm+mEIiC5qlCm5Fo+XALpUnVZfuViLPWIvQCIFD\/mQ5b6LLyUQK3IgTvQyHmF2yaLihlgfOHt8gizJDmHOSPMNNPb3mnnmgBeIKvEN3YHl3gY\/P+L0xM6xh0DRo7gQ5PLXPGyF1D00Easx1hm6x3kEF+whefRoM0TI329Lyf9C\/DN7gRBu7tZyl3NNYjPWzU0mJfTdJOsW4tT4lrtvG9drC+6rk3HcPtvlsk5jl5fF1lwPtZ0rxJD3kLaUa3XRh171OaM\/ZiOlwLRoRCjNGUdkDSZg2yhJJiFwbFpGfIAXJpJ1kjxDw\/ScBEVXe6SRDRrvOxx8kRmGFnoWKWjf\/CAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSGXhyjG5k5Fo0wiLcQFquadA\/zmxoSfuiiT\/\/TplQlLn+nMDZbzPA6ly3gwTH1bVLkbgAiQx4QOJ7Y=","type":"giftfor2card"},{"name":"Givex","paymentMethodData":"Ab02b4c0!BQABAgBNifdrYoF8tGus92zPakFFXih5UpuT+eNNHDUxAOZi\/0HgqoH7Rqb1Y7IVQWzFCl54\/gDUokbRjp7KLQftd4eh0w0rKRZt9WF1DL27bGUWZLVtI0NNU9CWllxjV4VBPJmm34Za6BJmMhfQ+zLU+7HN7mVnjIa5ALjWDsJBJL5h8X7oKMA9TzTh1gG1iomGJ3nGGMdZWmNs5S042Fr7Q9mgspFmTV98ZdJAx9nFAQl+yzz9JTqziTobW8TkTOkZFVTBpGJL7JxZjJ7jVBWHoWgmJjWsDSdElxfTexaaFv6AmGO0O7jIEG1\/16vxkEIM+EAWfiK11GRUi7H5R6MA1\/ERdRVv27A2PsG4UliBU4arKzQshHVEjPuE1gqjYlz4lQzBCMlc5Hwxoxlql98l1iXbsx7MHMF0qIL4BeTM5HNGuCXsPF0jSIOU0Izcwsn9qQf\/fBHIYktlXEg8mRUpX4iCFXVJsKtiG2aMniwv+0724iQzTPIrBYctGIBGhIM5nxl3AuCId5ViZoaKj7+Pfw08jZDd9vyFCyiFKRCMF\/eUvjv5dsa7IfVVZGn0GSgggMNpWAnYRwKU\/xfgJ5ZHeNfTFK2jOFCdEnjFK2jmL6bvgFdh5PVR5tDrJOYLRS+4MBKfzxSoUO3BcaWvr6ehHNQuJw0hGW9S9HNObgVAjTVWVRBedGwXUWo6lHDTgcH\/8UbNAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVqIw13EMSch6N9oRAeH6yyfpolZ274j09YkRrdFoi3640E3krm8TOXR6q5PekQ6voGdKQ==","type":"givex"},{"name":"Goldsmiths Card","paymentMethodData":"Ab02b4c0!BQABAgAZbPAxtXPgyy+KpWaluDGh77hrNCi3vdeV4nqg\/XkG2dXutXteYcj5uKLfD\/\/dGP+ZUSolKJ+PrLdpzvAbkO\/JRQIPTBQY6Jswhu6C6vkI+mu6dsD5EABoVO9TiGBrnu\/oJGPUiJF\/uX3hUJU4+o6MiZBoNif12tOa2ZSeTYkxmprOvAwd+JMUJSssSg\/fRJeXJT4iMlobq3w20Myk3feJO0ynR42XAeiyTB6iSPOqqOVTD2XFOh4wMMJWNtJ1Mof2AkqzFtFrPvOYLJLdr7bIKsOKXFhPx4Twb2yDb6eBL2BeRdP9PsYujI3\/B1bUzmDgZhyVflxamQztiWGEYskPBjfbZSK3m1Z0tsHg14trN8JqAR08hw2cblX4eSo9eSPyc2W2lgINHDhY0QOmxHWDoHq\/qjhtbpmEI1owHQBwKMQEm8dj\/lg7v+38TNuLo2cONFP55H8vdG6M1gmruwc5KSfZWxC1wwfO2loy5cPwYDYkvkg9m53oBeIbzotPANzgxJmbciviBtQ+IdAe6W6+DUTd\/erwMT9QVeOP9+cJlngOLvj7Dcnjk7l9x2GQVUwDDUWacql1VK4hEp\/h5h6mpK+N1mDXNl4z4sbWeM7R8OTRvo8WeEcxKgkz3Re79uNmS73Y1\/f5nw6B1o6\/B0sEtMFEXw6jd1F6JNKsR8IhUxDY6liK9\/f931i7fHZqKSQTAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbQFTtA0xTDJ2j7HAvF0qrE3gj1c0plKkK6A\/cQ6jkgBoMXgL\/LjHifQrcbVjFFqXz7tzyLgSuYyY\/xk1w==","type":"goldsmithscard"},{"name":"Hunkemoller Member Card","paymentMethodData":"Ab02b4c0!BQABAgBSDDWiLp4lYErsDSD+XimeV8jVzJB6z25AY37kR\/rtkZg8MHvPfEf9+ryljyYHTPrg5bTUEj6j3Yxc5jd3db8to24UiCdrwBz\/JWRUaCPUIJvFrWOPejthgNdCfttgaqfOdVknMYyU35lKi0a+pHuBvkcpZYxGn7Enm9Y\/n+GHMqjLdsnjM7bkpzTF8NEw0JKxUHwLNKCJrvVpe1wP5s8\/JDpt6E42ne3WgHSKcLgmxsbAExj+CC56Q0NJUgdFULHvbF6a9CGmFvHSvik+DOm\/KhMsWAdWES9qkzEw5Z83R\/pFHEMzX2tW5FoZkNIS32jIc7HSaKwHMF67PmdtzgjjemwtLLNctpTBL9MiSfti4B+XcOEBzA5LKxTyzHBcFZLXCioeakxRvra5b3i6PrkexvHrNOtyRwd+71F0Wp\/E+gzpb1KRJ5pRxC5uHkIiBOkurdcKjPKtXoLgpL48NZYWb74FvMj3W50e0C\/cJAdYRZp7yNf0mCvOhLva2ORkJvmaCr6Jfoik4J\/YA4QrM5WPCil72Ubxw1NBcIdoDAkCDJb1IrjvDryvxK2gk7ebVVd9xwnU2y+u56aYZcJgLKJ4XEalGZ+Cpnbw86q7jI3YQr5KaVfFB9yyhU3ZwshPNI3XQhirD\/ESkn+j87lnZWp7hCmsnc2r33ey2PkQ96jo5xBU+luThZvIVTbVJdH897rVAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXoEjevtwzQTa9rY3bi+w7qKrNij6SQfOT43DEUWmCoS1f+F9aLLZMbCWTN7mLXOkQTMdVI=","type":"hmclub"},{"name":"Phone Payment","paymentMethodData":"Ab02b4c0!BQABAgBiy6A6o1vNm5FJZBNdGlULclQpPMw0UVyk5sTZA8wlFQvdHt+YvXKWzkNf7sv9lgoUqGXIvNxk0K3y\/7lI+EGPuQHu\/RVlz1D26kmLxRp+NnjJy\/m4vxMSy\/38NgBJJcrMoXtUghrcKFf3mQ4MQNyZEJ\/IXBh3y\/E7aEDkfgmsSy7UTfNzhjlLzfBVDtLhXW\/QlJzFrV0iViSrVblHKZEowqICP0QwRJS\/XU2gX1xY038LkXj6s4NpBWJka7mQ5WNsinpRWAGeR+Gl8FCReixI09jziI7eJ7tDln4P4JfJGlLC4C\/pG6xagpVO1hyMcu9+wT99sz0k3QmEzWouAkiQnjMNRubfnyXJC\/wa9AMHrLfH6YkScbmutKASRScHrgd8jCBCEIDQ5jAMbB6ZhaTWGqWdwlIuIbmW0HBt7l\/pEQdVAW3x7PBUQwtZMGXMvdFKR4YAE+Lhsc40G7FUSlzLxLs2bpfMc99JUu14qHncEAdeS8XViEvYyR45ZiUWR9z9Fxwctiqt8KIp5faZNP2QaX97W7ySL\/iJuIZcg1IxjKzRc9ydtoK\/NZyBWJu18ti3ObXPPOsQMGzsndigh2PbCEtvy26PXPsXHlY1O1DHT7w2rBfg3Akf9tG57370a56vO4Lus5LkZvZPmOPINxlpNNxtX6O18XwhYjcPvA9IWRA+BXqR3KbrDCFBfURckh9cAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVwWSTKtbn80e21yXRcWWxceN6SKo4qJNUpQTf4WGz3Caaxo5WU2yKF5C7Y7yImP3pw=","type":"ivr"},{"name":"Landline phone","paymentMethodData":"Ab02b4c0!BQABAgAVIhc82ur8irH+\/b2ZtfjOmtNeh68KXn3JN3HpG68Ag+HcU5+J9Kn1\/Vv4YR1K1RgSBCBSiB+o7JHhD26pdHIvhywtz6tqltLZAoEmETfSvoWgcPIzXY1JtohNQ0tFbWIDq6jyMh+xCqheiSlQL6CEdpGgcSFRb4D\/J0mjMZ2nEgcuYkyt0UpEMyiJXYcRac\/9GHql8xfEPAVBKD\/XjGUtz6Ya1tnd71\/6mnBbY9Dlw9nK+Q7Lrj8gz6VrQi\/5sDV5bqNENK9A7jovi6uameBvBzlVfwyt33q+qxnNr6wcE1J9VLWhdB\/YKfexye3C0z\/w0wP1J9a8SFdHjd5T2m4rLkqav+Kxrd9UsCEatXZtfOrq6HULAw\/fVkzJ9U9cvlU5pronnEb5hrWhGePaXU84Ytl3OZguqcSff8Ua\/wI+9bhKRO9eW\/Aeqf1JWSjs52jO04Paw63GTTM\/mXQcENbJfqqk3xEATTUNMVDlSgZEPrytAU4ao+LZJ77tZEnHdjlcRfIcWjaHEtr40b3BhEAc8vCSMbOeBzES81VSH4Fq1W+LR3J7k\/xkcsfeHluXGVKypmyoOLNCzagejubPCQVKVp3jZjiPUh29U\/+q2\/aOy0hoivRNgo6sojwU1xke9JyJE5oxDH+WTbmCsbK+OrJJqcCdCuWbsiY73v45Cx98cBB3wEK5i1rH3AxPiliiqy\/YAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffRSu64ZrMMuTmwk6B7cgd93x7q+0WNHKAGNvJnpC6YdyCShju+eNCwNm069YiPS5OvtvM1OxwA=","type":"ivrLandline"},{"name":"Mobile phone","paymentMethodData":"Ab02b4c0!BQABAgCuF64yixDh9VfjK1wPr86Fke6QAVX+FXvop9\/9rekLpDOVhkNEsNGFu9XlPfbVHEOl24l+0IJPlCbm8KauZMjjDZoprnoYk9AfpMQxeXIww4sIOqtFrX69SSBqrOorw\/22c9eB+Ak4jY0QV65EBPEElG3midzeekcMJVlQWk3i9moaZEPoW5APbbXVmR7+JDPPCtxJ1erbdg3ES0kvkJMlcYuSg+ZQee19\/xS+m3o9yCXmDa2V5nUpTIxD\/5Lf8\/Zf9Jn65VgupVm3cEj24ycqWj+mc7cxWFzdp67DJNLAcAMn5NJIxVExPb5MQ0dz6eToHTMUU27eQ7NyIn2jYmrUKZe5oosEuHAyJDAFARWO98j8CCi5BN3Yy26u7AG+cP4JEjRZkP7lNaTM24GpqI6T11A5ec11hfeSx6\/0c5hdhZQNQoZ1OD9g\/+vLRGb8mMi0Ih8K8Ulm072exvb\/1BRrkWWJCPA02IBFW2yzWqa8YCcuFMnDjD2eOHQoG5YZKITbsz\/uN\/9aj7e1ReF\/WKvz8uJHfg5Jd3G2iS4TBNgOgfeOk0rNXb0pO6iLoyaiKsGg+LNz0v+gWu1Z0B6kinjUEWGG6P0649HRCb5a9P9HgteQSMLA1r2I5guRi69O1Pb2EEEzYsGKfF7NzidyapkuIG6zLXAfoQkLazz+9dCtSxAMGYyaEApK6bnOMh4I0fpbAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRJwnLsgKJqeB97bJOSJbQ9wWOvM5qTns+NZZs2uaRMsnAecuwmWyLuKPbA8IlCHFhqKj9z3+o=","type":"ivrMobile"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"JCB","paymentMethodData":"Ab02b4c0!BQABAgAEMTePvF4CZtCd9jbirjR0AqpOPWFCV25nc9lQzBq6NgJ\/BL8rbsbeYPEEWf7OWrSMdmiFjeJKZN9k6sxPWcb8D6AHgmVDklrKEd6R5qntMY+L4hNs0TP+Qcx1CzZY0zUFgrP4Gp5seRBKKpoxGUkAsBMgIeZRMQMaz4EUzttrZB\/2p1\/AjVVyULyw+mYl2AiRFCzFJ2HwUFAds3W37UNlOHq8QBcy4mGQLoTm6sjlIHpeudZtlkoRLnUhY98plBecpZYZbHiT9JClM0LOXwyoWPr+\/j58RROGfzcsITOPDbevuouswq90IJcxnsEdnbq7KQCminWgaSB5rZv4fGRWSa6zF5X+bBiQixLQD1zqq\/4apvoEoRcicEA5v6WVH3bpXQBhuD73HFVZ0b2grpq8Rq0eGV9EU4QWDB3mnkVaR1BzqE6BC0fR\/9SxAGeluSJn7HVXjuVZ2b\/XamQ0x\/4YHNPW1XtE5PIVOdtXH\/LKvDS1ceg5PtdEZ\/83Xqjx3Y47XZktdKTrzE+myWJnTD1Gzv1\/YN1k\/qOEiGkyqBAy3ympPI5U+Bu0S5xeilum0kjAWQR5bsGF9WsObAVJ4xPhkYt1V7p21td3gVTxww5QFDFkMSK\/6MY+qmk01gRSRIBflK0bntv01YTeG3iDL+MOALbnrY2StMQ3\/qPjJjKXIBBh9Ksfw+AtNheXk6K0CsdtAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifR6qJrtR6YnxrhZIBJsXHJDfTdPVNTDjG\/KdBq93\/LU+m2blUK3nlsH62gxSIeD+228=","type":"jcb"},{"name":"Kado Wereld","paymentMethodData":"Ab02b4c0!BQABAgCVaykYdBYOd9SXZhmtt153kzRwEhOK3aCqzeW7sdic8Byp5+th0EDWafwfIIG7LQLf33UFIsV5InlmAdVAvMkXRt2BAThNLqSwCR1+CZZMOz5okS2dFDKG9rdh1+KDB6frYgRViisaJ6W+bv77l54NnF+A8B1lPjKydCEnv2eN8\/3mi321AjMDqim8IHrdTYl2pE\/\/R6OEt1b1jALkhn+73jt6gXboMPwuQTpkNMRxNRP\/YapLkKX04A3Fzqnbep3BQhXBMf2YEXOjQw4ryVmDIojOpPjhk9eu8Umxs4sW96dbo0eRNXbNd1+ScDM4FZQPm8nQ\/BJ+dabn0uZwqsz64cJRx1+O4c3qwTsa8ztSckaCL4b7qKYK3rtYfzPfyOV\/wx4fyNHtbRW609eYOXV7ni66Rla+hSOpHFBQzhLu0SbK\/7pdBMA42cCvifn0CL\/gUjkqhi\/1XWSnU\/CiXV1P2BaOTLAW2rutEWMovg0bo58u4\/2MMPXKpcgGEYc1ooXWycZVxTvTBPKcM8BLJItjX3xABbEEdbCqJefPMSpPrvT7kFbvoxuIQhrMEYbhaCQ7i9\/LCXmqFZF1qKrUxBUMdB3sSAGvPyGnLNc6zCl9lpfirhZ73XdRyxsTzFL0R8txBXqxI4IiPFWMRt0+xV2gAFqBECY9FeoG9nMFFgSlAhBIGGTVTtPIaltT7xYDVKzSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQif1\/rAtDWA05NbEtqsQDOvnXV15H4jQAlNomWkD4I0cdKWDRiXzV2yYt67F\/2zz9IhbLZJ6yz1","type":"kadowereld"},{"name":"Karen Millen GiftCard","paymentMethodData":"Ab02b4c0!BQABAgApYI2hbHeDfES0QE9l7pnLSIA\/MIKgTloS1thlyAFgxG\/AV+rYnCQoHSn\/w3vWtjgM0rydLWjQdIqWsYKKeRBCXjqLWDPrYB7gaGT+\/RiO5w8mI9t3Ol0LnI+TwL3NqXRhFDarMkr1wBkqrynHfvcpbEbkLVdKSYWe88ZoroIiEAg3+q2tpn+fLwXuCvtUXqqqzYk+Bo\/SYJ0mbxISRzFIsE3ZAaUnLWtWaJf7rziyJa6jzcsVDgqpItpMfenIarVFcLQv7Sif1E4Q2o1WoPRmhvlNO7Z2DluzSaD+1Rycg9b3Xi\/pjkKO4YooCrDKDVthYXbe2j6RVsZCyZFJe9v5Egp3MUpnT\/XwiB+cbaSyPoC0YacoT\/cnhJ2aHTtV6HVKUZPD8Eh4jBdi8qAPgbBzr3E5LEtHuSYO8rWbZQMYS9EnJB0gm\/DtoPM4nHUA1pb0ffSBZmSQgCeNrr89ZfLvJZP7itZI+tjfaFoAY0LfzzCSge3M0LrZMADvqG8Bg+h2p6bnMx5a\/ssLUL7vnlyfGpl2OlhWDbJTkpqA5yt35usFniOMxkWnhkchq0BENL3wXl\/dAioDkSTdVPxgfZaOy9FSVJZNR2gCFmYhth6Yk55FBScUdIis2tykndN1ahSvH3tF1j\/H6cLFdq2B2DLoHoq3i3LeWBtvl61I98EK+RAJMIEwtPVsWjrNHuCdWhmBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMife0jMycTD84D5BBKAd0mGMSGHRKH+iwhg\/G8g21qaX1vqxzE1WJnq8OKTrrgrGEf\/fBxFsiqIQqp58gGC3vKtJfq","type":"karenmillengiftcard"},{"name":"Leisure Card","paymentMethodData":"Ab02b4c0!BQABAgBYdHBN0+5U1mCMTmWRzq5wTWWrDhl8i6q6yiiyPcG1froAbrlmhntvHiAeeGPwwnIdjfOrthR3HcO87Zs05HNaTwm9mhxk+3t\/MVat+r142qs4o5OKdIR4uYRIBRrjDG+UhUW1dAnNvrCCZ+kZFuh\/v7Tzfxy53ReTO4CAOFmsnUAqnynazVvyX9lMIYoTsd0KXjB5nLGI1DV4\/y9M2M4iyHmCIB59BvF5x6bnz2ILtfwRZtQe9HoV4WCO3I9titDktmdOHnCsQkKl11JZSQAIWEibGmWhuQmiuTHI+VuTW9qKay\/Ya5j5Sfkh\/eCOA90WmOaqynJWCdOCiYsd9IiURwsQ6SqH7kUoBJ7tl1UM8LpJyZcLDTX5HO\/nSwA5KBRw93cHeryBtmHavfH5VXP60FFMCQr95WCKNFfJv9FCVydbgaQ3UiMg6D1yBJtJqwOub6aWyvb133KgIpJnhO522X\/KxkHzVkARyeauOvRarsUlidn0h6IYAmwX6JVeJD3FlnDYBOGoY+Ik2DzvBq35ylfjKrNMEntkFoYOQZjaB+4BIUp86pJSq\/bxukfA7+ML7VYrXs0G16iWBn308k0Jle+qyUhqXC3qevJMp87eG3mrgaBr\/Li3IfaBt3o7ItNdG9d1l914lajAmVjxeLqW8Cv\/tIsCnal6zwBksIE7HhCuIM2CuiMCRzlhHA3BBpZrAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifW+wiTHgcFa3INU7aod3xbsafozYBWij96xh6jiG2bD2YdA984ypmZ41uA0Fir6Wl1R6nGGZlyVdrw==","type":"leisurecard"},{"name":"Loods5 Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgAPp\/\/FjuP+ULAnqOLFwnVQX3pGuTlYiMmSXXg6EejxddbhxBf3\/CPBEzIRktYwuVzYbMeNrxbAMRDArExdZJMcFWbBHOp9pLGcT4mRWm2pmf+aRdKNygeS3mI85xlT\/l58PpHhW4oXOzp0kh8UE3dPbbQzbMucaC9FJa898di9kK7CHBOinGqGscnbJuzBrD+O3Xf2MshZ9JtJhFFNbIyLgbwcv\/YExyMkAvXddLsVS76TlrPjqQsCOCEyCU9+wwjP5GRaIHqMbwx+5vD1Zy8Yh3GB+fqmE2JBbrO4vStDSUcRJmonZ6eGmS4DP76lQ46AVr1PY4KwZO\/ME4Ku0XH4vK49EJKQISqklllxa+2YkGAh5DsLvD0tAswfQ5LvvvmXIEacKjfYsKNKa7w+Z41Bn7PZTwLYp+FBnynlGO6AmRYgmJSEag4rCueZD0qJNrgcJqMp33l0eKNb72wDQLZ5EsXZ7YihTq9gL\/tsVo8sgOrZV1AKWhnIYzpIwSNeJJ3clkqOu24Tilj\/v1kqiDI5+yn3oaAZO3crm+GTMWY7jxKmH3lY130\/jdCMHbPTugonAlJalpI6s0vfA6LbFcYX2BgO867Cmox9SSBN9EBG7a7FNB07Pf2keQcdeaWg1DwldGPSMCtMC2oDaMd2s3exyrnEOg3rdbh6Q39rfhOJOxB0Rv25Orn7jDkaBqvqMf3RAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTmdrSny1kEEHmJD4iRcu\/0ZPmgSqVodRq5eFhZLL38XWtH7T03GQC1BdgABBaUgDAjZ+adh2El+70f6cA==","type":"loods5giftcard"},{"name":"Loods5 Tegoedbon","paymentMethodData":"Ab02b4c0!BQABAgCXTxvpM5NovdKZ1\/8MSJMXmIDzrG1S35D2xRgJhlfH+rHlcAPdEoeS5E7CcUDK\/pA+NsqVXSKV7YpPlzDI2Hot1wK8+vhHh9g3hCD\/cCtThplaywBeAKWQ1YYeXqCiSbLeNAtTDWs1RvPAwsWpDbSFQ1VnXS+kR9vE\/T1gG8pthSrpV72aUg\/Mm2mJGNe3BJxzou+2eU0PEiKW45EmQNs+1QbZLKwvE0ByvATBb6+JvaXJqdZYvk0j6i10EoavvcgMQEdTiyI2eFwX7o+F0B0GFRo46ACCQ\/BDwekg3+tPfDsc6WLwNn3BrXCR6bHAWUcPQ0EmlCRDdg2zbT0fyHAGV+2q8r6Fzto\/\/NEi3xRJqC4uYvKg4j0COUfZSJseBuvwKaSoEZmVyni25Y4l9QSOeGC90hJZ+FLbbo2M5VqftJII8VUBc0o5bRKXCAFBjn6iDHa\/FzS8PLkehLkAkWlU1QRUV6qDfOfzMhAT6B\/fGoXVq3EC+wdwsEhZP9\/j9DmFTuLBZ+z8L2yyZcDmhKD5137ifvtH7StDaSfpOdZWBGSOTpuA+E8j8AqfuVjyuoaNCEopRAV1Les4mIKv0juyIhxsI+cgUU4sDfKqvDkzD\/smGGhloC80enbncgLV2zCgm2ysuLTORBlVhhZBKnR8aEA\/faDii0UIJE9b5bOJnRC4VefeFNVrTkgBpYzhmpNyAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSuDGOUZ1xiT9pv3ZxvzDjXdbJ0JQnc5EWVrs9HK6TTPDiBmRDhwvzvrVYOzTJjaebHY\/rg6+nzHLXMgRRnq3A==","type":"loods5prepaidcard"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"masterpass","paymentMethodData":"Ab02b4c0!BQABAgBvbRPkCdday6ekCo+Z3GBDCWwcGOq5ZiTrLZoXTWGZBUHw5QuXfypU2GIcEEqLfSJ2B3jtCDUT46b\/LqyOskbXrcfe\/SlzkMpgtjYyI5p5o\/fXAV2EYSagdIVYN\/tjWvTLvabQqxTmHObqbeSh\/oIkoe7XDN5gcTZeqpOuPe348uJNEhns3+CuTgfuh5n03tkopdKlPKSeFvaN71WhOLmWnrf6cT9UTQz2KsI1oR+JVzSOcW5YACk31D5BIkaUwJaiB1wzinjIbJA5hpg8jofvqP3pY1V202mpWSki5vGWXhgq8DkqYzg4FV0E1i1jf8PMBH\/jkEOAkwSV2CCfhQLGppXGjSX+aGQfhnzxuP2JlmCRVMarGt7xHOyUUglKS25S1xkKYuhmnwSJkfd2UuGIqbkESIVDV+8SXiz400lAtg\/MdWMmvxszUZwPsRkP0eeCbvLUge47dYKVXb1ebWixC1BzXeZkGxOOej\/b+f45JQYmHVOvoLkzEDUv+HHbT5Olez4AWCYUk5OuXM7ao\/jmOa3DGmzVm6av9LahfeiiPO9fYcX8kwoFHZbKcKRVhsTwyZ5\/Zy25VoCLnmYcDt4hkRQe9+nDd5BePv53YyIgkkyDGeblw5NKRtTjisLo6PxbX68rGnoTEA8a4La7s2Q01QghihIiUQY6QzkLnn8fVxD7U9La\/f+dChIwRItGZbpSAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXzgfp9PSVL\/Gx8GNCR2wS2qzDA67ZCQ3hokL7QtZwiELsB5krnOCZ4XyCrVUK5QwO14XEq\/o4bM","type":"masterpass"},{"details":[{"key":"encryptedCardNumber","type":"cardToken"},{"key":"encryptedSecurityCode","type":"cardToken"},{"key":"encryptedExpiryMonth","type":"cardToken"},{"key":"encryptedExpiryYear","type":"cardToken"},{"key":"holderName","optional":true,"type":"text"},{"key":"storeDetails","optional":true,"type":"boolean"}],"group":{"name":"Hitelkártya","paymentMethodData":"Ab02b4c0!BQABAgBZosT5R1+\/S4j4HGENWWA\/iPeQfkjxujhtONpPc47hauTzDaeqWHJVh\/hmu755BpWjU\/4XNyfPXedFOHRNCVg2r6WrkYMxS++AGyGsMpjup4FNnb35pkWCZEk3meuoijhvTqbziyZErUC529L22BgmmH7gpayBTJEf2DSYnTsSv52A5ieJ7bProcb2ylGWyL0VhXdwQVYfVdwoYXbaV\/AZvu9s5tf79Ewf4mt6cnAytEkJSXgZ4GOeFHtJyPdqr9pe\/wjASrog7XMS0EzhZ7rGI7eB545wGFijwmnSlsrF0JKM8nEgfTEnSW8s9arEEwC5CH9u8a7ahgfkcR5G8wka78bd8m0rOh71gobaXqzsh6nDLJxoVJI7QF5p1AooTJJJil8Q8HZdBlBFfwBPWHIaWon818JCgNLnhycIpL4pJ5v34K+lh4NQ9I4be17V3tFGAXvXFiGeBMP42eMTXhGwtzOgywrcKcLdcrzllxlHaK4PEoMkheJF5hsmMQ58xW0nZ+zEwOkOHh6s0CFHR+FTtHJvkHqWNAW5LQ0lCEm17qwG+7V4KZ0x7fIYN22wAmsG3QsJO1Qi3qoBBZncC6ppLjuImAghcOHBwuuBNuDZhVEQq2MWCKtQH4amCvghhBkMKkR+y8odEG618NOEfyFl9heR13Zi2pC+A\/O+cCzf+xA6xBwAv+LrEpCSTjdefnALAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXngV9E1IwDTD0Fo9\/bupGuso6DFyZlj0mI9j0PLt6HafBxtnMl+oHVBbukZfj1rj7B6seM=","type":"card"},"name":"Amazon Pay (Mastercard)","paymentMethodData":"Ab02b4c0!BQABAgCkDBQ3tGm61ichxvJBt0uLArsrW0pZ6\/ZUCT4v3yeMx1GUHVywYKo5\/SBT9fA14QIYOyBSEvDzHG+EVDKbsq8ZGGO82ArjEbcpjYbvn8f3t10es+3Bn+TzlxvJiybucfxm2Ix2d5yi\/MTYYcdGKSFZlSxGFTF9VNDzMTkP80rzRYApBdtrFuRTAPW4h7z+tWx996HBYUbiv0g015MHCHS0SoYh2jPOHhCm17R2xBnf8s1jcpIDnjZAiMj3VoZemVSzcYMtumbuU+R5v1oUaH3deAEj14pu91iCgpOmyTQrYiJgg8p9u7uUCDXRYAYgoLVkBIut4PeFma7I9Z7gWXqrSt6ffHTdvO2kMmO0Ogc7IlrBrF62koBdnfuJ20jDEjodF\/LaKwQ\/yyh3qxo06USQVNvYXl+J+E\/iUbNgw5FR2A94I\/2MAfxiMDS0ztdBbAf1QzaS44oJJ3uIS6zlCGGcenxfRdXMjOXEKloO+F2C8XMvctctJVDgY399VCogiZTLNkz9STRrjg4r5cwZIw4KvXMce7A8KWSK55BldyGq0x4de0n\/lj4ko8o7ToXj+\/PryBvtUjcz67+i52fLxvr4i8iqls9wSBkRLVfKD+VfKjJxnVznDdsfr5aDBa4hGwANGbIuqI4gv74KXCdIWbbJqTfdD9VA9q49dg+Iy9D\/VhDFlUAxdRLmb63kqQ26dgAFAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQr8SVcjGZnuArjQaqBsW1KR6igs7NQaTIKzWHB8oBhPefQXAmoe7TzdgzdRb4+yoAYJPcPYlnLcT08=","type":"mc_amazonpay"},{"name":"MOLPoints","paymentMethodData":"Ab02b4c0!BQABAgBIfzDmB8qDGajvq2\/hGWIzlhAAftTCqpB3RZLeP\/TGvZeKFPe+CMIFnX1zNtOhy4NP4CEDmM8jHy8xXedS1QelN1pGXP1nTko5vMr7qi9EFkQcvSvZpwO5\/Cz0njVYjFgZAAvJwK4Ytdg4osnk+3X0qrn64ZbsA8ibRGyqEEBAClvIY4AMG2cGXyqru3ltxwVqIc934NpZ1NeZdgE8zFEuNRLdMtGmAfigLDkRpRf3sOlPtpY9u0ge93ibzP2jRjUGy5YLUd1CFJNx7fhtff62r8mNp1Lb9SBCu12cnUNVkMsNH3mbAtK+q2Ck7Jvd9QKiIRHbJYRnPv\/LN\/nYAs+Z0sHBC1c78hT7qDayuGZ+haasm5eem3V80JuMpw08V2IWdGunn7pkGKJ4ldXUw0tUCKD7DSUuLa8Nx68eiQxyzWWRq3PUYGUns60C1ZXkOKwOQOhCfx9jsxjNKqRN7q+9zxHyB\/aCM\/fZkIBsiNpBqk9aTCMQ3TkSCxI3TsFoefDOKZXDqFWxCPq6HVVGt259XwVMIFZzT6AKCdC7OcWeoPw02aACQsj9dnkKqh6HDGhAAre9pr\/mPC\/p7IcpB3BDnDQRtCssFkXUFhMNVxmxxyb+JH8FShy5YnaCU7P+f\/J6Qn2Z8CNJyr2RZ77s9N+nthMhKxMC2D\/3CjwVI66TixAYIAkZUUhlX6XEN8KJq4ayAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifbFQr5zEUMohN+rPBl0SdluHCYZWtcZCKV7\/8yzvzDoQYYo28JyLUvJ85vPAXh6Ii46M62I5TA2G8Kje","type":"molpay_points"},{"name":"Moneybookers","paymentMethodData":"Ab02b4c0!BQABAgCTBiPTMkm+\/q0GuKneUn7WEoPf1DtL4xj6+SXQxAufri9s8gesf7z0fDcZSqiApb0UaHPJvZKWIEMonp\/d5F5h4jHOzCNqMK0kiTZ1l7vw0s\/aCawT0y0P7Ymh5Pgg2l\/wbiAdtV9neFh4nT2M3Xb2c+Do\/yzIOU0LEVauTvCyCrIZfHvcfi+hZtwwZPxYWAlzJKyVpmD5RYlf3D9OHuk4nNjfGXY2uyaf7w\/0EIJIhukqPnEey2sizgxbz7qWgbMPAwbWmLynwczbqfGiI3FZpS2zyajTOXk46DcGJSifc9H2arcxg+O11JhObCp2v2Stwh8DDX\/uoZOhdLf42sjZyioygBgfKpOnELyaxuevhaeNM9c\/jEnYDdSL9P96DifoCGLGpn5fAGADskxHszLyoFMOP\/kRbbIeSnHjDpwE4Y6rFLXOpKOFJdjx9A1p8SyHSjxhV\/G1ylk6Pnan44fRjORpEH+sF2XfDINRCwZ7EU3lH85n+P5g6c66vRbZMuGssb9KtY5yX3Jc\/IAQmY\/kS7WLmbemqvCCy1vMTwyk7J2Nhg+DFhLvzEgBwrDnCQxV9EzreJXOEtBnQ1T9w9nQmrp+NjiPVcHnfIPSRE0enAGy97fff+nxxqvH+yzm61XuTVG\/BRBjKwqbS4m3nORDr5klpPK3NhuUtTqpuCpHcxABoFJFarRJiVuHipKn6DdgAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaQpyBEyvmrF90NAwtfp5vweigE4s433Fuo+TBuMzX7RoiC5Iby4MKfDBrdEF1TRbztiy1ZO5Ec64oM=","type":"moneybookers"},{"name":"De Nationale Musicalcard","paymentMethodData":"Ab02b4c0!BQABAgBMClK9eoxk3I3\/2Uc2XS3cNA3UU9qdSYKQWnqw9cODwxat\/NB2rqgl8VffbUy3m0ptFDomc7bU8jMHoKRmvGuQ\/eWI90bRT98Djqtv+uSIdgywfdxmO7vLq1imx7eeGYJqGCgAbJSHjxmy1yZtE8tBK0dbtNByCbh1cj0NFHhTma9S+2OQZ\/MXDZizQ\/nNywOCKbdwPgsNnWiUr8wB+qFfjUokSN9xQB7eUUCR4b2XUcXhLF4\/r2SKgZuf+lgnuXN8LoQH29d4S4TrM0Ta9UKRPoXdrE\/Jvn8an6HZfdhg7U1bWMsrVUV4aGGyyAprpncPN95g5jTZXconVKiQYqzwcwJhcMrL4XyEmvkkxH5pM8CxRnHGXrBWbXomKODH1H7fGWMhFi0D\/LYIDPcM2Wfa3eZuJvZbH7i\/tuLPI9BzjdfMFzQE6sZbjUmW3l\/wu822w0TT+BgcPTf293vPV7WX4ijf8JcZ0ocMtP66I9yvvJImjy2Y8MdjCcXiCK4HN04CZe+VEKWgfKCAiv9pz7Xj4LfP8ohxZg6W8V17GgHaG+Hc6pV+2GppVjf9GuEqpVGRpxCE6wPHwUJHTdPK9BT4Z2ddmQvmjHBUjfObam+6X42XbC\/KGdSr\/qSkPOuwbp5Rcv6VOZi0+DQ4VJFzPfsMyePQPbU7EEcXQfVBLC4kChAj01Xd33Y+Ap+GLlHTmQBIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTZcAEoJQj9aNMkMYRkEpNwSVuZa27xiaZPz\/680X5J2Oj\/Y0egTvIkZhrq+XW7Dw7JOmpkk1DAwVw==","type":"musicalcard"},{"name":"Nationale Bioscoopbon","paymentMethodData":"Ab02b4c0!BQABAgAGKrzkoMjtFTu4fnBoLjSBEaMe2XxSmcMZYBoyXHuBL79m+JTEbU\/n5LOmpjeHaVqUxziB5Tej3GR55t9aWR5HXY9vCb\/mxJ4qlm7xdVjb6Yu56ByP9+IjpIW2sTViIOsJpH+44HzxJAvWYHeot4XQaUf1YF7Q9tgHaRVPKqS0nXWJp7i4Nx1ExVb2Lof6WrkGSCdP5+M7tPKxO\/DBpXa1ldCYcb1ubWTyuhHePgvvTga6\/rLdKXyvezuKftLOC9JW+a35AM5O7M3k9+Qes\/cisZWWnvkrNyaPShCBrGwIWu9O2U6qd+2bbaDBEh9qe+GJdUkK5jxY7EOs7F3MeUbWoZiiNkKvp5BQqyh3VoLVGAiZJQqDaPlOQtX2iCI3cqYbwgQhUI\/Y+LH8QLPaE1Sq2gyAeZo1CCKa5Anmgj5rhpFt81SPSR3h+P6NeVNs9UypRDfn0oMRRfONoFNPsl92bLeqi0GjVqmI1Rqw8M7HsH1NLt1MjqkV1ea\/oR1Sv1mLTX7aRnaObFjTgDlAe2EW7\/nSigcxwVGS3ZtqNcksCWojYzDlpu58Q9tnTXRpDy69LjE6KgsC6R8tVumcqzdIWXm9JwWCYIrNZsjb8VXaNH1keUoh2nJjhudo9HpC35gPNqa3J5yRt91qq\/XM19UgunGFBMF1doFJn+NY4SCHExANCp7Bqi4lrg+7BndrxnriAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaOHVpDdzaZluQ0EsExLisZZe9P8jj6B28SWNM5DRuFVIYeo45SKNYL491pxNOffZYGHFCeHwS83mYSO+aNSMjgRow==","type":"nationalebioscoopbon"},{"name":"Nationale Tuinbon","paymentMethodData":"Ab02b4c0!BQABAgBSdBjHAWFeVqdlSeSqA0QDmRkRKU9VRbtV30FXKabZ2HfdlbzZLePz36F1dcX9zXR4BZoWazM3wD++T\/lXOJRiudsx+YBJzj1WSQkOey5wV71V4Kq5WPo1lHChvm1HoYlEJ\/8Jnw70w4n\/Wiq7B2IEy37XIoltDFQfzepQ0Vc8C8gOaH7DhM8koFeASy7CYJM2zRMKDfYhsr+5CWHdia3hfmCv67g8\/8JM2xXU8sRZ5tNFqPCTCW+DMSGYirVEqe94C5TJosaUPQdZ34m3HgQW0dDde83vWPeHBD9qq60NFK5+ljsYboh+I\/Ko7\/qYkJkLjJW6XRjxFSsUytrWHtvUE+g47KLyQpg+wI0Kl7yuaCdlzXqrIDOqRUlzm3\/GvsOlQFnZ45FbvdSdF2tlWq2hsheDNgx1UbcsGlgR2xwDqgfUi1DYXwjHvLgg2oyfyCTjvWXZRpSX0TMYfroD4eBXoUSBHNsw4dcJ24LMlR\/4uDc7XNDATMHWcDd7TGm1eND3hl9QjeQpqcdVpsY2ag7EHrufk4AdEqcgCQwz5jPXsWXwgZX6SIZfyGtE7bKNxDl97kJ9FQhSv2QnhAiPLAleg3Qrd061MC+CAjqOHxCGWCs2v0\/SR3qlRMkk4WFn1FHfz045fSfRRz14x3cDcMkz2arEv1aK\/OHmpNs5Ki8+6RCuHNwaTlfgUy+vZGMZA\/xnAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWnZH3JT\/GnQpJQAGmVDZNXUbNQ03jywRl\/Y8cUDt2sV1z46Y2z+hLkgfwjd1mEQy4RAXTPdEgtHP5txHGxx","type":"nationaletuinbon"},{"name":"Nationale Verwen Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgAOvsGqCDu3E7De6XOZvDu3GAadKeXW9pAYVtP+w1bqxGPUsNpOvkR9VtnoswfuV9vmp1BPUhOjLx\/ntsAIA9RXqrzROCo8n9p7Pv\/zhcF1sVSecN4O1ae2HUoFsHUxn1MHWdOwJygEWEvNZNroVe6z7S6e8oK+CAaJZLO8L77\/wMMYtnXG0l2hIehWEqcw+dNR0hQO6QrLz2cnekzu13A6DR3pkwRrZ1oyyfGqTxqb8JpSS6xuiXgryPtFOwKccmnWH4nHNu8qc+emuRipL++dlIp0bS22YhVyseUuwBBR+heYgXL6hnmNjKqCD2Qos2XJ40oO3eNT96hxy+kTPHkERa+LlPnBxb1FFh4iEir66COeE9\/YGmnCaJ+GyKGw9BWIF0lg+qsNxYjDDHQ5JXnddzVc1f4mtjaO6cyR1zSNQshu+IXraPkczhvGI4K2BUJpEOp+9zCCWv00U7f7Hj6k\/7UBWM5GQUVkBiMXXJUmxzqxTyXhDL0AikNJy4zg+QvgIjQHtL8TFdGd\/vH2lyKtkDrQNnHfLgyGM1kftBlGwn71BpkBgHM\/S0q0laFnHGlwMmOydhWmy2dBg34VREea+8wcz6jTKeCepRp4QZRAyibXdoxah8OpL5AfNqxzXfTR1Q5wQCTceimL9Gj\/mNQLOaQLxnkDkDD8zsgWn5GI7BDiepPIoM7gdgCyVya5dTzMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTzqh8Ewli4hyfJllzYIZ2tLPPGyRVA6wXaTcI8+3t4S3VpFjS1i+gGatuMTftnuF0xFr99rBCNaoVT\/AWKSjMETKiqDdp0=","type":"nationaleverwencadeaubon"},{"name":"Onebip","paymentMethodData":"Ab02b4c0!BQABAgBKxnRmdq4ct6jF4AMU8YvlVD6PTAZ8LGgOaj7Kvp7Ty1jZpBKgQE+nWkFVMxLWSDVZV9YbxhXa1Ux676iU3KdAvarZ3SNUMx14Cf9uWsfNbD3eStRVuri1Rn\/a\/rtXQiGgBkl9MPII6kQbiRLoHf2VCyYMsaazdZSUVcq22oLOHUcoL1Pi0gZ4+nGWzUWKgYh3KjqtavrpUEo91vBbz6MA\/zJ8o8DnKjhcbK4SgHYj4EdrN+3mJ+Swdm8FN3t9WvQCFcu6ljhyYO9qeesaJo5xhgpeMtrGweGiJuoNAxE3k2l2Yi\/062I6AorN8tfP3Ndx8PPhqmKr81hmRhV36nWksuCz6Xiw4OkQ26Ra6xQ3O\/x2Xg+AZbOo4Ifug80UErQZrApNCe39tELNy539kWDMrvvbWDoT86DwRgvyGiWAbGrDBMIUUamTc\/LOV3HLK9v6NhyQQ+HR4w7W5\/Yaov8EjK4Uf5YygHdJfw949TbWEnYISutr59FmNp1LQ1U3FfucRJgciOj73lsvumNl9sbWS9y9vxPGBfQyputojHifrxyOJCLUCO47vMc8EWbr7sY2Jp4D552w1mfhpyJ8ZNC+rV5G0YlKqFMLvapomqmHoKdxAY6Zq+PThEZfmqc+CCeCbeQuOwoDs54u6DbSK9qYpSSQ7S1JxNVxZUlqb\/+2zxB0Ss91WpOwJsz+iefTsbBLAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYQKtCYgKMO+AOBDbpjGbqKyXMBtXI8euZBIzH1RBRZOjQq4QxmGtQMvhdwTHZSerMybSkw=","type":"onebip"},{"name":"Plastix","paymentMethodData":"Ab02b4c0!BQABAgAz0XP3DwHY67V8x1Kq5j4lUIyNcxhyYTeFvi+o\/GsDs+\/CUmZOgs36zBOxZoNQlx2oZE4gX1CIvJW42O7l46QO18yk76FjW9z2hEiu8OUBuyVx2LCOuoGbf6nCpLHDbptCJeWmUVjvvLrEp5ecXJZEF61LJRnsCVBPMYQGC2HZg+G5fMwgmfTQ5GflgSWvJJNhYewaZEt67kIEMkH23fEWk5fcrwXsK5RLCdGiPFtfroryjT13DLimjis8cn51wAeypTdcBLUDb3YDVRB0GhTMcTBOUawfga5YA+j7iXUBOTZA\/s63dDncGLRAFvMADdXHIwAdfzpcfXp73P5WmUy1xVfdFL+yT8thdDbsimGMFYW3B+DgxIST6DHvdYRQcWeTWHaeaBbxBLSlssgXZ\/uwZ1l6F\/U62jq+lvp0SLCL5VV9kNjYL1gj6ILq7Q4kpBlakMUCzD5HyXFzJTBIO4ppAnNwQNXxV9CGWWejaJ7CXKtvkMhMVxQuYEdudJuV6rjkgfZ2TaHtJ8ZDabSQCSlHwgNTbC+NmESnQM8NiFWUmRUuDp4bj1xyKsSgTckTKlGeYVExV\/DNjLhVETP4z2nshwNjKljFFU6tswU8fLlNIS5bSrBbntbDQpz9EyXSxlTGMn77KUBHsfj1snOMIn+IyXStUMhy+EukYyAs0Xm1oxBzPVY6E\/USD37p1Djfz7E+AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifcImGyztGTi+gJ8yHHByRjLvwsi78BpqhidrN6Of1kKrk\/399Y1IfZp1L8TkLTL8CPE\/j6ZA","type":"plastix"},{"name":"Pluim","paymentMethodData":"Ab02b4c0!BQABAgCpN9PgB+5PbyuCmztxgw6+aK6ao3WDV\/dDAYA4yaeYk0kSzCzSd0BScnh5Qou7ii8HijCNxdlLKa+KOfRTK2kUey4K0lHKqzjVBWg93+ls1WdISaSlwN6pU127jcQy7ayLhtt3Gay5zASPvNLuQfbQQUi0BxlbpgOyYN04gOyhdbHsbGvRqYayMNOeXLg6kcPJr6UtNvKvkX77\/FAu\/q4UujghWe7pY175G4+kmdYlo6iW1pqdNjdFJvHizzS+MxXozRckbl2rrxrw4PTS5Spj5i9EbfUoaBfoNt8SrDyxBroh4cUqPkNbX2gN8SZMHZ9Xp5EWPK\/TlHNfTiUfgJKAqXiN+9NTmDowtNOufhtckm679r1BZlhPQ9w9Wqw4NmO5lMv2VfQfO3q2QKM4DTMzOms9EsGVTaXixB3lf6ay+GzQZiNQpiB+PtCkcJjkRtAkuIR83Ru4MSTI9t11vPSY4sQiNw2hOkxUPzXtDinSAJQ95ddPfxS58DTNRIpIgQ08puopzECpWkB\/JXk9E4ZPachueVcLvAm4eOhBUYggtbQ1OtS4ifoilTHUISmgMBia+GeI7kPWfPjBumAvYA6RiGTP9I9F2XbNQNhNPj+A9Xz4Tv0ezu6Xatl\/5ikGUjArUkFUXse9WMrAQ8goojA2zl70rIsfD8FApqUGBuviPRCGzN1z8R7ZetTAgE8mqbdsAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifdHayxrlLM4RXYxNWex0cVNe\/l+mirjDxyZHFbANdCJUe5MtnIPznUnI5Kd\/ODC4AMbU62fupTbSvwU4","type":"pluimgiftcard"},{"name":"Illicado Gift Card","paymentMethodData":"Ab02b4c0!BQABAgBP8UNwgXCInrEhB+jYdTLk5ia9HzyhVcM903mjO9aU+YI6HwyqK19e6kzOx14TPy4uVwC9o2ZSG9jj+Q4P9crDepL6ltz7mEdBo6I1d4j\/dPbg\/ilL\/I\/WONbzyQuYmBBzZI1f1GQG5U+iF+d0XM6h7RrVS5xU6DZLkFkn8cY\/QPMu\/U+CDdjJKHfTUCyAnNlkBhM4olMHJK9QKYsxDLBbVRC3PeobNU6mP39wCCOqEGph9xqayFnIZnEI2gw0axCg\/m1wCAjKgwfzlLXt2cZE2qy\/V9xHxE+OZ\/7rEyAg7YPUYN69R+fbXfRNq7hvxNeZ0D44oYeEhCOk2k8Ue8AgnyUT9sx2gehBVw3GbvRIQPdhSN0DQGVXiR1MDgwt54NqvyiXEqR+gtgyR6\/FcWV\/\/e1g9g1ZcvAzLaFT\/CB1oepfOyhIXe6A2WpsCgXZ+ivz4sUKNRcZ4gcX7cG2beBWsGz+w9FHaXHmY0PxygmvA83PkAK8bts3ZM+1Z0B9eirW1OoX8xUkO+UzesCuHW4pcu+sr2wZD5YDSt5twGzzcbcpmSc4Y47TmewJOYl\/VuIwDd4l3DwsscQScoYQY\/1eBjC6IBOlhrmsUbL\/yq9917Ij9ScYEQ0g2pLiyM8MZY1lLHg143+ypIsfkTzIQtcYr1Bk7imHgnWIR8vqf51EkxDWYMmtYA2KtCSBqaI3nAWYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWGCfN8Hg6fIIN1PcOKhn5oAXs30jSfkeuIABFhakzz4Ik6vl627\/JIlF1x5yta1+FUrbmuIkryal7ZE\/paOQw==","type":"prosodie_illicado"},{"name":"Rob Peetoom Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBPrkGi1lxsmHWAZ5YsdvcYyX5gSxxx1GKvThlarnANnNV3\/5dcTI3kfq7ED+DIuscvS33bMGGdZB0zWWk7nEOKodpo\/QmhQpuqsdy126he55Q3ld+CX9aigM6eFTmCqy1bQNYqPJDzp9CHl0gKxRmRjHeJVAgVN8ixQ0NcfmcJlyk4cX1unuuI8jfLbpROYUij0bLQbQXIC68sgBM2WDaJB8vymgN+XAJMBsRLxNe\/7FKOaXptqv6L3HxleCXdV7hYbEvQsW5BVH4jo2u2ECmC7eqeU0YdQ8qrdXCXj+TAtI7jyOhSrEN2Dy1K6dspL2ralleyHpm3jmrhS+NRDr\/ErlvEKyLB1+xkrgDyMdDj6uGHNb0g9UJ2O1MU1\/+bc7GfeGp1CRDq24wEbRp+YtNbZ5e3sD0h7o4E0iQcCDpowZ1EsMqUsy1ORCtznaz30tL\/jK30yfhhuTtNhXC\/xvdlm\/jkDiZHYRUT+1d\/GHc1Q3HxJnpbqkYTJBrK32gu7\/lG9b8Pob9n5CnbN3My9vMLcBQ5cK86d\/F+0i9hSmj+TiHS3cN\/11FY9TRH9neNHLnaLmdqjSfOp\/unodw\/Ug9L61QgOB0V2d1H3BUM0IMWs8OBLFqZ0NiDvVene5COcSSEPIFfO4+Wq9Is7OworoKwzaizc0QelJPzbw5gIIccXRBuPDqtnhc+xY7wD8T79IMeAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYBTWBV0iDuGH9uoF4QDbEGJ6Kdg1kmTtSAVix48HVSEXHf6AR8qT19UQOL3PSAaXzNdWzP939pCbZ9b2LzVD2k=","type":"robpeetoomgiftcard"},{"name":"Shoes&Accessories Cadeau","paymentMethodData":"Ab02b4c0!BQABAgCamYFI8NGAGQRFMz4zD9ZaMmORJl7JgqyH8MSEdmNSgVNNXCdjwxq42EpPta8vNYIJxoHwocOIZCR8zkOP07CMS5\/tJ8\/GPz4LSMwBzc8cPxf1iGec+7SwpetVWQ+PrBhcgGN\/zhh2G\/XZT2VufjZyy6xb3H5BZRtzsCNLjAJvd9LeWjh\/cVymCuKnZZ8po0BxEiF7D6HVvHqOt\/ien96m8iAhAwWj6\/bk4GdmhWaqA8DFqb+qTbDQ5CxjVtCVB5nFvbquIuFWsuA+vV0FcpmJUUXqRi0T74qLCpoiavztSedKK3tCs4OxlOocgX59DIiTdnmTSW6RxdF8QUavk3xyX5XRhO1qGlNRLXVXkEjKhwrMXHUXJMQt1yMQJ1vd8gLCgwNtJbZOkEr83C6H8y6LazXnhFGDVWKKZ7KCS+QTOQ2mtQj\/bRa6DKTenJXitXYoKFKMAvY\/MuNPJZBj4np8KnzMDgpnJN5sLOyrWQFczdYEVPPD8oYzBagVRxVBdwB5+7I0h6hxsKfAGZIdbW934p2Lp72b8SmXMPZval41FS\/j8wJ1x6MbcQjBbAcz75cHIqBpOXRF6j4dWVndwaKcaxzBgwz7162rI6OsMRVrGHNak\/4FSM68ffeyUHdf3NA\/zTE\/\/weNErLmxjzvbNFu7Ghvu+IhOtDTyi3ct3ewGRCP9b+BccSXwIsgJ+NkAvDIAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVuHpmeLlJGlRnY9U\/6b3rWTtSTca85zykpddNhov3AIQzlrdIgACu9SOITAeyv740R3f0t2L3fy","type":"sagiftcard"},{"name":"Score Giftcard","paymentMethodData":"Ab02b4c0!BQABAgCsAD6QS5AWxVyPO2sJyskpyFh\/tVIVCByXM1cSTo5bfw8SypTWe+4ZlPHPc0ezt84DhXEr6TOfsjXS9ASKFkanm+AQvEvWvLLfO+l+T3RpxbmOQTGhzx\/y0Z2GiPtvylE+Hi99Zg5kAqwW1U0B+MrnN3VQkT5UGScY2\/oQPtpDGIxM3q1pOJ1wmc7xU3TRaw+C7r+WQhGmXvAyRqYd4KWlRkNNzaG\/CRXiekrp3dMp2h\/FqMetJnUyodp\/p3gfC+JtpC8UDrijl7enUJ3pN4VLYeeAlU0XtXRFjqT2vT5Pwb21ZIPvY0ViLVS75lW5b5t4zvGH\/gU0t\/0MuLwBEi9NzfH+zKdIBxldODf2Daz3fAMfo56ThHC8UuBncFYHXYT04bMaVSbkwfFgxxUXTv\/LwYZYKgnOkU4IgK0ZCCPjMpH8xLj24fUEPVcPJI2h6C1fFWtgh0H2lP+XQ4b4qOMa7b2paLyLNEFxI\/V48KKXBFOtpkino6vXzKEpYWjTalwA+8K9PYfF5FFOXym36jNY9dhijiBoA9\/qoyuQqZmrmQ94HYkRnSIR5wBfkx73Hr0U6stj3fwsd55M20JiGKp7bY2z81VCc2z6mpmjRyhHJXG5d70wX3ieNqKFNStHyW5+lkIeaJW404Svytck3kgchxou6CKVzvaSm6aCsGTG\/RCFmAjn2Z6NdmHBaQrSXcutAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTD4OtVWJcstgpTY1+ZIpSrWXEOWsSqSiZuQwnq6u95IdDrYQkulLduW+sOzopMVSSmaRLGtgdS3Y2AR","type":"scoregiftcard"},{"name":"Premium SMS","paymentMethodData":"Ab02b4c0!BQABAgAEOrM9BagQAJYKZQNCiGHVFFsCC3VuzYZrfoCCn55XO9TnTaROMV0h\/bGll57gS7TqiGuoCeK1l4Y4V+aNv5OC5c\/wAUBYDw114hWAsetFwu6pXLv1br9RIJRczpyvJlmRomRLPQpaN7cls0typ5WoFFzp9WpwKweFBC34ZIPLEyrVyZDWnxVrq+kP6p9BfLwGaxjE0cxoTq7VLPYtOpSU7Pxf0fDmEd2Jmb0ZBq6Ed90TYs\/EyNQX\/UWEMjkZstMGB86zCbroxBMLZBmF5GErKIIeyAuAylvyA4LrfTg7T00AUEyD3X9viyHFigtxUkhDGWpvK8iS1cVmygqUK3h3DXHvzKmvFOdfmeI84TEhflFgr6HGCNSXKmXmYVVZV9ZJp0nDrNWGvIUqfBCfOc4N9d7gMFqJsUaIW8eFqpwpObivqnqtN5ZMzpWp5Jc3Xdrbwa4N6e+aer17AqrUQrRqHSr52XtZiIWtVs0S5XJNQJRjNU\/Wvc7rg4Y+smVcfpBJJmhWxn4EPtNunALAoMiNRPDxJSOoJnM2aampaAQlmc8A+EGHsykWCG4xUjytLYWcvOn33lyEIAEui6Vphq4sdCnAfSebf2g33BuMZrjzJsaapVhjtARxH+mT33kdgm40D0WkE3RplfCCAXL7LOQgErWdRYoJfTxqkRHlI4bwgBCEwecph+cqKikCuEyH6i+vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYo3nNjRHRR0bt+z9AiaiGKI3Jq8ondSBT0URcHGdoA4Axf1iwA8xF6ux+c0RBBUoIM=","type":"sms"},{"name":"SVS","paymentMethodData":"Ab02b4c0!BQABAgAeBmmIFVM3F7FmI7FUeX8E01jMco1k+S3CS+awh7A3cCfpKvVuolk9y8ot0HN9Z+RnZnVzRj2khOGPL4ArHUHJmBjCxknuuP7eVEZqbAR45z+FOl2uCHw7508\/fLLCLg6F+WxliWe\/9zf6\/kLz2rWgo2YIjEM2Id7uper4lCvXZW4pe6IRMABXnR0owxpv3ZFyGY7pxGst4uLiQ9NFmbU7\/5Q8T5s6tSvoTTMhQ6jYsQQ1UQGUxS1DzPaI+QkMiBOxB6iRPH5hvnLdfjnsEBFZqFwDxqmJXokHu5pA8ZcPD3gOasK0yxkrOnJsvIYxqbgNYf2v\/366osBNzspcwHySDS+6qJY3ELOhr3iXu87zs\/JF993pdxvcS5isDXPZCUjx2zt6gqvvOSmmUei23TXbz66N+ESdfP2Z3AeYbA5U9T9f2T3QpIQeas69oQk2TPrkqeC3uU7Hpebbg8tkE34cWCRxWnwrtCfhZqt9DWMDc\/yZEPz\/P9AvpfcDb+hRe+dlfjPiVMSN1XB1Spc47amAKQ40f7FJqqEPfTe7EpgAoykt3cOPnH2DBQdkD7+N9nJWX8586qRXy5iqF4eBgpce9PhNYrkAOgAnKINAZt5sHmXqyvbvvAtw0f\/IViyz7dGjBmCqgVzA4wqpEyKi6SPmo84cJz1aP9TmVkRl4z3HKhCf\/wxj8atKh+FTzLWQrdDGAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUdo6211\/Wzc0dqvxJR3\/jWN028MVDDJ25rQjkrVgftRgtIjiWwm7vIdtV0o+QnEa+g=","type":"svs"},{"name":"TCS Test GiftCard","paymentMethodData":"Ab02b4c0!BQABAgBolc\/4\/EGNHf1pMDEsUskyzhi9KYN3VJ0l3+0ZjemuURepWRERtEhwImXhdl5R0+cnJbs5jefQfLVytf5e563aoA4lwnadk4XJS\/H0qrhBjQ+9uC8ZFwxAKM8Q0Sv8t34aidyRAFl1IxEc3GjbSE\/ujiYL6LwwCoRNOZB2GgojHGZPm7Trh5Q3WSSm7d6LspS\/qgLN+P5QdrMHg3395mh4ITHNll4LeBePw7tFjuaOPB7\/MuDxmauyaHDs23knh8xwRKFvydDikDNjANai4LWhNX\/74YWBPiQmI0GZ2glGiWUeRfyaD2VhHxAiYdPLQT2GhcDZ35o7Th2wX4HSg76TT60fL3VXOEOAinunSOTQo0dcY5aN55O2CQ7CzK2XxBRc36Jy7J0gUKk7fX+Qa74eG9YGfHGYYzN2QIDCpFK787syWcKQ0Y6AMyQTYbcIs\/iGkzZ9V2URyBh8sUCda2nhpBgLq05UBRjPu73Op3DsS6nU6VxPg\/BjGc\/rbt3JF+cHbFQDfiJKiFQTOTQ25gzMZ9fwW9pi0ED13Yv4WCGVTbbHGoGePSbMyopjzcwcqhSb1LyPmpKPoGeHS3wnrBRK3nEZMWUJ6fNkX2SCCVB3\/QeFxK9Psmr10\/pYrso2Z2lD\/SdoMebrdLFWRKHBuI98Z0vHs1yyC6TJhJ\/AQOfjxxD+4nyK94vO43QSq2eOfs0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWfqRm4x6b1yAPMGiiE\/SNY05neMsJjWAP73Niv3rOlQnzl+TRhMwVGR2URszHeFIwAYF95evu7q+h7Ui5M=","type":"tcstestgiftcard"},{"name":"The Sting Giftcard","paymentMethodData":"Ab02b4c0!BQABAgARZxSi9l0bosY++4DiKLjUe1\/\/9X4LNxVhzU8cuZlqFg6AKs64qmU3Jz3ckBYIwawAQ1UoRP1EH6l87scIb4E7IuQC+Yy+D86VuV4JgXp\/8blzq6Ix7uruU7TsGbCMiRv+aI1DWSrmjk\/PD6yElbE2D6wuN1zCz5u9K9FAH6gh8TztyGqnpj07fuxbJZWGd5V8pi703k3YfdSDAaycUavf\/6aKYp2oMGKxDngbxJ2l0qwoQfOrwwAVFAoXIIWkGmUmk8Ez+bAThUzmOzJ5X93le6sJUPQpxN1c4Ak5avVko9DK8VWtamkIGXBoW0cL\/FQDxM\/yfvIbcsL64oCAFB+5LUv7+5E5W79YY7Wf1f7U1ok1bk9QWgFvG3pr8PqxoITc7LpcIlitBeclfsBD8C5Z4KajJN5k64ECtcoXUdaGtE\/RmbgfWDWGjIcKsCnpRcS3fHWeTFGFatbins7XL\/v3LVzKVPkZpF6TNGhsXtqqgZeV+vkIkCq7E\/GDddpljLkspqqSVvayYEf2HvKJ7yorY+5s0DMXaEqE8ZIdI5MF3SQXDozK2oqpYSlOY5bPAA1t9bR9PbvN0NX0gtjo\/bcFKs\/steFeNY\/CkXMkSq8VBnV3L4xmOBo3fNN6UIOFIehmrZpjzTl1xuLzL6TbW10a2cvfHCxn09RiFMeDeQrH7RCCTI1cd3NmyITBNEieuinBAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTU06\/CT1jKoO7oqHjl3sfhGodXKB1a4l1iTtGs9B3evGnR3Y0sjvjFzH8+ucdSZuWJxSE+1lOP658DGh0hb","type":"thestinggiftcard"},{"name":"Ukash","paymentMethodData":"Ab02b4c0!BQABAgA5EDRTW1MJj4ec5EAPY1ATwMYvsgnwLTbirwaXJCCGiCe8I8CgF3jXymhiHUku2JYCViZcRK\/tCz7oAMUX4wxjbZghHlmZqdzP5BE\/KDwvO2Vsxr\/qmSotuFvbbNigiEmkeBj6LoR7pQGvSVTjcsp1W3mL47snog+rsn+jkj0pXJhZ1U8\/aXrbB9wYuyaPWYrtqeDa1PL3BcHtf+Z0wNpdaBP+LpSpgq+klmUARH26RgaJ81EwnCOxESR4Uyj16bPzmAJUTxMaZkC2jHughbG5tAJn8AHFZyVTMEYWOM\/1aYZBJ5v7KkJIN\/Onr+oYhQIaEvJH3OplSAz\/DW7z8+8jJ0+5Frv1\/RCApVUSfIUOlN3q10OtGkkDgGnQ3ku7zMQj6AMrI3KU1tsmaw0C\/B17ZZ4z1XBSgwvUcRiz5M9aNCg6yNs5EUvdYd6hrAwM1LDvrioq+F0gWlTW3f+8Pzydx8GMLC\/xcYG\/CJ8KWb\/Qwi2JXhrG+ZR\/jE+VHvzSt6zuWaWnFP5pY5lr5L0tki1fbq3tT8EwLP\/TdF4LX7Buk6uv8jkQMC6pavHTJ2zSfmB1OZC6VJs0KbSaphSVhe9ka5SPrrzH\/beuNQpgIosE\/tKIVs0YDOepJvyPHV0fXO51fOX6dwl0XSSnmVnpv6Ejf7NNPkaqrHZ4TFMamIGhzBBC5PaMxFRWVoLbpQ+\/zanlAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd+vkInPycf\/fO8hcPcxypCKMgn8r6bUoLJ6gYhTB80iJ2SvRW7UelG619SZCjeiejweFw==","type":"ukash"},{"name":"UnionPay","paymentMethodData":"Ab02b4c0!BQABAgCyuA6AzYVuq7r0baj9TvTCObZzY34GhJXajSgYTq5YtvuqCLGYU89mEwIDl8WJeGPmeeoKLKwGr9D6K8sinPMf\/prc44smlae8cDbjQFVyHkA80aOICCEVOaoj9Ku3pGf+1T3\/MuML9yxaI4LFziZS1oTw+K4ca0Lhf3anHgK0czR3jjwpyywkku8am8L2nTZTBms8lwo+2yZTBmL\/vV+WEZhk29daHZWMKsMu8luX5tgW\/E+UHDye\/t2riHv4cBDBns+bV4\/46JmR21mGYqyH8UwtbIFiSJBmR0jo3\/jiXNrwZL\/gE0KKoDYFQ1BecK+2AT+0LkyFdzepqMEL9eMLh\/Th+LbGVlXFttBy6vNZUHXxHbHWdW3u3RgBCpxwCdHy+fcSGfaOKTfUBuSB3Nwd0pHsS\/659ocRfoRxO9pKOGVIqye4twmX2AwygEI8iw2maF8r1JmsvVvTliiSt4LJLLvs51R5atfLqG4yFpjN1Rb3WXtekzncKfn6kADN9nnUHkI+thX3Yrj028TyOXpcGSjhVLAF\/YUFjHnTQuc\/0mY+JpyqtOBamq18DGfFIjwoXAq0\/rRiJVsPwTccI5jS9MAqZwVOl70Q27fYYG3ujiwbwW+REZlxGVOgCDu5xznDKLICF0YBeAi5+3dxfLepkU0n2WIJgXM2cX5pgVyqLhBUouM8o96DqR+dzPm2tuAMAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXLVyNJDBr+PMaR5skK\/WCNJ7GraYtn3IG53OlJhFTvHAkSpSXjr7aNW0fQPF4V9sKyqY9eyHQ==","type":"unionpay"},{"name":"Valuelink","paymentMethodData":"Ab02b4c0!BQABAgCXS3+Lg6LwZu9l\/UIyfkrHZrwgOEU7G1xft73fqNOT+WzZ1qc6RGFxgbgfxp\/YT1c70OUKbO6skjYBHAygugKQRw\/VR\/C0KeRsmP2peysWmHeqTr2goqlz9KBd4vYS9SWMO7gZyPs81M2WvNqEECIsA2EidAoKNtB\/gY8RTXzoXMP\/ZdhDMx3jOwTmJwngiycyJA46d8oo6eAFeiO9iJg5d\/VfC9yN65uc8s0hBmFmOqdMg7u6m+Qg52pob1K1U0uDgnxkWdcYwndFwjwz5WmFZGXYOA1U1VCt9n1Wut9L\/U4Ninrw\/E6VxHKfAgHHYLyLhsFgLQ1DLRv39o8EzHF6EhwT9VofcqxOXxff9DxCvQvWwZHch6SSKqDLLCB3p66r4RxAJ+UxBhfmi9rm9Tcs2AcFjEZSWdTYLtABhlTxkZBg6GlzltimC1RUNInnmK1Ne4LQIdg7uJno2PLvPzIXFgE1MVM+E5Poms8mXJpwZEmsouIFfZc62Vn09YmOwPJWiDkeyuQ9tdyiOI17hlPgcsDZTRXQ8Fj25RB\/L4NoBMakD9XR3fqVsoxRW6eWmhjHEEQTvwtEoPtQo\/BR8105pk8fb3L8SPjxH2jcPCGlF9svIVWJgt+DUtit0SKfRKvb8icQoNzNrFGTlsfIAhLSTvcvu3DDI8vrLJwOXwE+TBBRrXSqOwIRPwEx7ifaQEd8AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifZvexSg4zbtYaHe40B2pdrLV2LDz5V\/XHItrgI+22VOX39R8C9vv4skekFaHgZVxkstbOzkZCf8=","type":"valuelink"},{"name":"V&D Cadeaukaart","paymentMethodData":"Ab02b4c0!BQABAgBXdMKsMJE6QVzKoo9KqxS\/uQcqEhtL4e2+W6p8fP9l5tNvDC34ynhQfI8e+XPB3WawOdSnwNB1HTeRxN3JkWLm\/ei0nZjJObQFqjD9YeS1c0cuPSRMnGd3kogfOsjt32SFt++BC+NM2xhglKqLewi35NSIeFpEDS5TW1VuIkLSUsDay7rd7Nxgy2Ob2qGyI5LpJgBIKhteDfLTW9Y0v1row9fG9xGfOaGWdSXLpDii9ymngo6ap\/CDvh+nIRmr8QXtkb0jKv18NVAOpF+Icd8jbNCC+0RIXBDMSFiPE3HQ6Rg5744p\/3dFkYU90t7FnG81y3IVvlPc2WDHqCC37hNKBxcx01PuB+q0g7384XDdt0InGgeoyTsRnCiVj0dgBDCCwc58tmLrGJOCjXXUEfW2fRn\/P6ImmbfqSFEjVo5jYf6fZOoq8eRqbIIDrAPKEyS4fAmvFdX5XLwsQ+9VZC1DCseVTsf43Hcjtg9dZbFfEaCQ9bi+jlgah5Qt7Od6X0ZLrolPnlxnEKgLqVo+Bi2n4ByeUgSPEzWeKyjM92C\/4Xz6mFvY1reRr5FOyCu7Jso2ev0p9IcIPlx4PR0SUndKhNRayth+2mMmUnQnFQ6uLdh5WFPOwXJtvAviJEg+Ar3yjQlqDoMypKP7yik9oCNE6s4U4f2VbEUTG8CilMPh4BB2M\/bd05FUVn\/nuRXJPCIaAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifS\/x+tlxsUkQlFOB24V+5fVdy5RAOSJ4MqfntnMMd5C9PS9yyLvFpMpl61Ll5XZ6h+6HMZYTR26H0S8=","type":"vdcadeaucard"},{"details":[{"key":"additionalData.visacheckout.callId","type":"text"}],"name":"Visa Checkout","paymentMethodData":"Ab02b4c0!BQABAgCRBzsU5zUnZKcgmFhYDAXqzYkmTbNDzWpSQ8WDlMrVK5qNsuWuy2ZaXnD\/Wwu8w86\/0Hm1E+ftEtsx1S3puWyDYsn0HkGsn7LMf22QlYTapAzVKfMfy04+ftonzfa8\/F8CwoPrwWZpLDU3fHuX3BeQiZJnNPJLBx2P6Q+R\/jLnOLqNZLJQpn5AgINh2PMVAWFs40Rj4bVAK\/ZKTLovtrvOTv9q3DrbfA4Yi8FCe23kojjTS+L0UeuQ9UqaFsDon69UPlLBgQCae\/5mLBjq5+VnRp8g0Rh8F+8ubNtYuV5CRg7eVv2EmvKru\/HbC3MXr6QLk3ZE+9Z9n7ZxoS3Ka\/KyYEF2ezr\/3vtO0Ow1z5eTGChZbH7nnIHrrp0oYSrm+sAzuNbzcom578Y5yfHs+x95OFOiWg2EcrYgvhiy6JWzKDkdkiPbU8VUhiW\/WDO4g5UZU7Xz5l1dAaUQ0u181Z2erZYG8uohFHaLaCoWAJ7q7ALJGhaER3YoMhyIvxF5PDBHo+PJL9fQi7DBJ\/4u0VN3a7JG7Cl51VDn+2+u6mp4yYIDyel8AG\/dQTEQzI8goqpVhmhbztIYbtuy1Gp1bzpohKinkaz85KkeSjDa4zrgWeE4NcVFXolUBKCMr8lbop2bC9e\/ad5vIgBbQmcoSuvSI5vneZHVpLLmf2fx9vBlvBArh2yuY60lBQFujwx9ZqRKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifXV86VMveVKN6bFBc1AViWY+a8zixARejUFEeswDbijtdg80oiA0iK7yixQBMmJp88csCWkz95KSaOQ=","type":"visacheckout"},{"name":"VVV Cadeaubon","paymentMethodData":"Ab02b4c0!BQABAgBuWnaPEjzVEB8\/NGLFT1i3XrlDJzrM+WNb\/Jlv5tb4pJctyyRwbUtHE+Yo+7v9XRANk4DGTuuMYL5BbaqbuUvs2k2JbgnlWHrqqcjA7cEz7EWRDEm2m4jWnMi\/KO5buk0BbQ+Ki\/7YNPsSkuCgUXGrIXAST5GRPzIwFYOS7M80DzlyKi8R7TdJAu8nsnpihktLBVOHBr9WrNRMe3S7p4Pd8a2HJGD\/CakIL9u7LXYhqYqgfkxfdvQrQFaz31p2xU9s\/o3kSWXT\/gnCJz5MuUhqXiudI9mNroS\/AYbUuSZIFFnuegd2t35BW4j8jzvgOZyoPRojqCGmAYUP6aAHShe6XB+7PN6dAIhJkLXznSpIKC1BtyUuG3HyUOwqFyKtt66E1\/ICJCmAAfiZkbJBFaSIUFnx1EM0hY7McaHS0+gfb1dQvBhJP\/fyBDpQAx6SaP2JAG9yivmzkH3+fMNoP6sxVyCX5EHnblAsXQEWxnJGZWWLzB218sox24jDHj01c7ZcADh4gowAJDZYsspaTgddheORCW12ovjADJFQKGMKEtpbFNVZ2TQl+mwBss0cvKspm2kGAPKWX0DjKa0HHvYnepEqAHwT6Qhe6PXORHbK\/3VcXdezEH8uyC6W9SsjsDO6GVKpWWItfOOfCqs\/\/3ViAbk6p72shjiFn4Lu7+B+HBCaAFBKqrM+zvXaV\/tH3eP\/AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVRLRyVt83jIBl71hMGKc7Aq0HNbfIAVFcPCegIt3jqjLySlfdxuP\/plZq3KB4f7vBdLHdqQ\/3WVzro=","type":"vvvcadeaubon"},{"name":"Webshop Giftcard","paymentMethodData":"Ab02b4c0!BQABAgBw5gIZYWEh6Zd7RAM0RcpQNhnPRtUAHANn0tEb+FCguWnzFfqRV4thObH9oySVyjYp1vbALAAJGnkR+Xbm4KLf\/kWzz+MsMidMXC+FWs6hz8covVAtzRIIvEXlRBB17lLCeH9yJnWau96Xrm9l+yZgk0EchvtQoBmYeqSb4sQqJYkQdFQTTJHPAea6JrczKFcheU86s9QeSbzKxUOzI\/0ORulFOQXEsjk3Evm2fQ59KL3oBtcJF1GRJfcWQJ7zZ3JRhkyH9g1+Sbbfj1UYtsyl8d+CTDwFuqWmZyA39biI5VYXBW78id4DuOVKdzv\/Dv4zWy0dXDM3Voce0oZIRwQBC6lg5N2mw4RGAhp7IcUL+4DpZcrTOK4+ED24EmWrlpTusUkHNX\/SaV6Hs35PTK065jXtXmn++GvF5BzA4NTAn+shTTHCsl5sv9rhmmwx3+3BCzIj0cMAiFMTsVZ1Tx23+MnUXFIqkljRlyD07FnIXIbKeJoGtx6t+B9EKHCqEuJDnKWIEs+DnMRQzhiuaOh5n\/G0f06Q7FG6PYAKFGTe\/tw+GSKK6j71dYGgWycNzZeHW1sSNFVRL6pURb3S9RBMjOpeda3fUKChbIPqhjqF+wKl6q7XQvm+w4dKXHyhGI5DY\/9Vs\/DX74vRxcTtutZMhTGxI9JKmyYDQToFhwEKSxDXjdC8tIvsJDu7LQ8ve3nWAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQNrhANo5lS82O3KSvpHQtFHz\/w7XKDsG+sZhRsBQY+N+1Cc49e3d3xeejiToANWLbh9llsOy4hRUnTFUeI=","type":"webshopgiftcard"},{"name":"WE Fashion Giftcard","paymentMethodData":"Ab02b4c0!BQABAgAhMJIQ8zSZ6B6qQsbRyoLzMkLbJnIcfJHIMLS7tmbn3eRoZKTRWbey8PIxoyltacmUJkU9Hktzqrcczfx7UZdEmS5XumukT4NnlvUeLQ6iBNiTm0WNqDqgL8P8Vzpu+6GJsT41oxrPWQUnRIkh9ZBjqkq6Q+RVHJwsYTIdZpKGihaZlI3zNBgwSLs2LzlLnAqLARC5X93KvfNC9WifdaPentJQmmJUx0U6qu1Uj9a6sHB8GNNWBRZW7sV3HhSUR6Q\/FXYxZXmufRcqM9rYxIC\/Ju4EV2bJ+jLaoPpXu7PtOXiT39VGaZ0aX02gehuSgVQ4hjw1i7O6kjcKUm6PXXp0JYFeH02ysL6eUBuzi0ULP09PYg3CyFukvkec+RnmEQBAcWCQmzZ1orHgtCYXCwl43lI5c+NwO4mbNC0FL4f5Y\/UgDy79VFKUd5l3w8LwAEint4h21nMLKZYCJx1S1eCX5shzx+cCSd5GAqWUA77nXkUSwDBXXPmIp+GKQMkK7IFHgG9qTJ9rFvadF52PyEv4bsWcjeAyz6+CWOFBwk5TtEvSKDfKLAqU9+me9DfTP1QBY+FJYiBrOBW\/uBgv\/6NufzaDBWds4jJOVpo8S03\/yNCvM94DTJPIRfibEwGamM2qrERp86e1wjr0ao8B\/Zlc7ZX8QDzqDmpTCHT528mbuBDkq7A9lwTJVNkf2laeBxcqAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeYhP3EugLn\/D17cS8QOqpBIMSUWAoJfWN7rKm4sTQWjtXSso8521xeQzTTR3j4Lm4b1JeZiM3Bv46gVcq79Pw==","type":"wefashiongiftcard"},{"name":"Western Union","paymentMethodData":"Ab02b4c0!BQABAgCCqIHVjvWFfoO125G0Qi\/aWnkQVzmVVDCo+XpJXABFD4JEgSxsq2trLYLqxixmrJXEy\/e5RS1Y0KD2omwavOanQ0NWqkoerbCle+t1SAC3rpMYodSUhBAQluXCSvMRXNFrzFpxeK5+SzphqzTvgvLuMCN3Kyy4fBzCjXeMJwQB5o2DraGMt6w193\/\/nD\/kVGGexOhMfFNitRypd2g0ILs1S1O+rLOh2UYvEKczLbJ+xOqtCckSbE7t\/A28y+fowJxyqbDZFn\/Di1r+bK2Q+B+CvAcvdxbyrRJeJDQSvYI54rz\/2qk6DvzLS+yKu7uZmBaFsd8GF1Vc0CJWVeLZ1BF\/ShquUwXWWAwtaK3zYMy3C37QEJizTsOPwU8LgQ5xvzEn2W0h8+YrWqhAHnLLSfQv\/QyYlYuSa6MYcp0CfuC5Wxr0XQdHtDtdTDx0ixuCvG+bV8Tey6pEABFVDFLtRHhWWsDSlFJi35EMawzt9qBQ9ri2mIBjeoTZVmYNHHPoQSU7lTupadcQnPauOy0gTc98ChXlDQaYIxgXjoVHoQulaayi5+HDNFH6FgJEltb7+vZ1chT83KDM32bigFtQjob+vb7uArSqC1QZofwA4brnBmitCTuFFsWEf93x9kzru5cFKnZZCu6LYeFBqifpRDnTM+8OcmKjXXUv4OpzUKy6hxDOyQJZ+vzZMa5eASNa1ISYAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTr1ArwVsfDs6+p1vy4hzFpiQEO1qZlAmr0hJBKvgtDG\/ormHk1hx5CoFvjgKJj\/g9ORllgYAkavtqg=","type":"westernunion"},{"name":"Winkel Cheque","paymentMethodData":"Ab02b4c0!BQABAgAuGTr7Hb+sS9WhMaJbxMJQhXv9kpCTqWbc+RpEEcDBam1sWPzqrAWeyEpqPp5t0Ts94E3zW7RTJ0AyEvhVS+KpGQKn+EI7jt0liVbDaqFAG87xZdNdtFVXlfBwMk4DLWgr1QOYW1AABoVcVV1+Mq2hL\/8sv29dh9ORkTf8fFv6BuEGFoEc+Yze7k5gLXnLrRkiBVh7WhpZR6TXMZvebgAjBQ26W0erUSTjzzs4bVl5ZqsULqmHmjj9ZrI+MZ2c4orYMK8SJXb+qKZ697NGEazsyMZZRmOG5NBYzOEjdK9\/SdnabgRgqxAWhy3nSQfqNgVArpvfivFbup14x\/ZM\/P2P6xBFyNyK0v5PN2k9f3gFEUtvM0Yz3zj2p9qAw66U6+ug38u3luiIwLHXFv8Mg87ELftuOJwruAYurvCqyvDBY0j3qgBb8fa3A6EULfXU35V0hVo6r9SHW3efvsocd6vjKQogZP2Tgf4e++kIF81n1w39xSPaTaSHNnc9HEtFcEMrgkmFlm7+MWAIf14xWi+jDdPtJtbSkFE\/lDqxsyE16axJ+nCZ2914Eiplrs6Fmq\/f3T0QXQGXsZwTXMwZV8ubAa5xv5Sowoi2ZGVzDFRhqxK3PfdQIVNyS\/U0zqDTJ8Dco+0DnlPfS+\/S3dLHixJzJDJegh1\/cy10Vz8QUrBzpRBOKwDnktP8pBxNeO0dVr0nAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTRFBBd7HtMO30hv\/1qeyRVC\/ySeAXdYL++1P5WngYLi293p32vLL19uakeOYJbh0acNqVNS9uERfhQ=","type":"winkelcheque"},{"name":"Your Gift","paymentMethodData":"Ab02b4c0!BQABAgBwSzkAZFP62rf9A9s1eTR5eZelvAMGdp75eyxk2\/054VREmax\/NX6bgGYg6hvpRuE78ATV0+9jI4LcwHKCMuXsZWWqj9Ro7hddiMuc1ZDOVmCAchKVnlR3X1R4I8eb4U+plSY5C31VqDBC+tGAdsQjm44Y0e9e\/W4kF6SVU7UIvh8\/ts8McsFMcBNc\/gvQ\/fTTSgLyjghJaDc\/1J9ZFkgtVgAoTSqgziytCwx9J5dV2urWfAX3sIKyI4tIMgH7C2zOvdE2W6woJlxuMC\/bhxUmt9zM9RUWJVzkwaVKpo7RCQzquoSpO3M+koHb+kLLp11XEk4MMV7jVbqLYl4dOS5iP9kzcce0hx+SADNlENxL14W9EHHODaQaeSPrueBGlf4l8GZMny3IQv9UzmSS\/xWvq7lOPov1uFyJKXFI2jILR2dGA6FK1+CSuqlR\/nkyQcQo2XFufYi9g2HatTFfd4MXkUSHF4\/TpdFAd8AshyabLjhOmjbXZG1zukWW3o8Lo6\/rELOloFpQpdadsXb0M5vZVkrzKIIjHoY+EvGB1urnbZNKUzah2W+2chqSC69INtIcGj1M7r0Tt8EaMg4DVAKMXsMnYRIwp2h7g1NiWvNcEgENUCDpuuWENa09yA4siPR9aWcLm9nukW\/TT46erTG3VMhKF++tVp+GFBeFTr83XBDPsKLjXgj3XpGkvhHlmDFKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifa+nTY4wbmTCGTsoOuYLTfMGaYM7Hyyz7AXsLTj951IZvDN7doNuKw2PdTY9Ed17dTickZ0Akw==","type":"yourgift"}],"publicKey":"10001|BDF03F216DE358DD6AB214B74BF0F8BFDCDA9F3EEE0B369DC5ADBCBE0FFAB2A4FA1E31C49519BCBC7241824EE45F7ACC5B04123446D105B713135897F6CBC82C478DF3B26FCC0DEDDFE8BD2F29DBAF35AE66ECE6AFE48C985A08591CDC57EA2B35F2551CDEEFD3ACFB912E0530B402549399C93C2C23CF74C444515FC6A6E5D267A4A2E51CA97F304608FB564DE70E1D683CBDAFD7E869123C91962380D38AF740033D52DC2523DA80CE72097D2ED7D1CAE33B60C91AC2F6307795808D2D351FD112C283E043F1B266C2C347DEE31EE8D606D512431BC5C9C01099A967532EFA06698F130AF5005ECE0CEE3FFAC24884E2C7F6FCD48666D64D40056CCBE62579","sdkVersion":"1.3.0"}" @@ -13356,23 +9762,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "074516", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9SJ7DN" - }, - "pspReference" : "993617894903480A", - "resultCode" : "Authorised" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -13393,23 +9782,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "083996", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9SJH66" - }, - "pspReference" : "993617894905481G", - "resultCode" : "Authorised" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -13430,43 +9802,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "036240", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9SJQUL" - }, - "pspReference" : "993617894906488A", - "resultCode" : "Authorised" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 5cc0ebd..f73435b 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1561,29 +1594,29 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" } }, "schema" : { @@ -1602,8 +1635,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1617,8 +1650,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1632,8 +1665,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1647,8 +1680,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1667,8 +1700,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1683,6 +1716,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1740,8 +1776,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1755,8 +1791,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1770,8 +1806,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1785,8 +1821,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1805,8 +1841,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1821,6 +1857,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1875,8 +1914,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1890,8 +1929,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1905,8 +1944,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1920,8 +1959,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1940,8 +1979,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1956,6 +1995,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2029,8 +2071,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2044,8 +2086,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2059,8 +2101,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2074,8 +2116,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2094,8 +2136,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2110,6 +2152,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2183,8 +2228,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2198,8 +2243,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2213,8 +2258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2228,8 +2273,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2248,8 +2293,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2264,6 +2309,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2337,8 +2385,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2352,8 +2400,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2367,8 +2415,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2382,8 +2430,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2402,8 +2450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2418,6 +2466,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2491,8 +2542,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2506,8 +2557,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2521,8 +2572,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2536,8 +2587,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2556,8 +2607,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2572,6 +2623,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2645,8 +2699,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2660,8 +2714,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2675,8 +2729,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2690,8 +2744,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2710,8 +2764,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3140,6 +3194,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3398,10 +3462,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3627,38 +3687,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3981,7 +4009,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4010,7 +4038,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4068,41 +4096,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4307,7 +4335,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4374,12 +4402,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4388,13 +4416,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4408,13 +4436,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4425,12 +4453,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4439,17 +4467,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4472,7 +4500,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4516,12 +4544,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4534,12 +4562,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4547,31 +4575,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4863,7 +4891,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -4919,7 +4947,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -4933,7 +4961,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5073,7 +5101,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5223,7 +5251,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -5828,16 +5856,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6515,7 +6533,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -6534,7 +6552,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -6570,7 +6588,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -6648,7 +6666,7 @@ "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -6868,7 +6886,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6880,7 +6898,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6905,7 +6923,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -6914,8 +6932,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -6998,7 +7016,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7061,12 +7079,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7075,7 +7093,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7090,7 +7108,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7099,7 +7117,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7113,34 +7131,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7154,13 +7172,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7171,7 +7189,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7180,17 +7198,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7210,7 +7228,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7352,7 +7370,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7362,12 +7380,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -7407,12 +7425,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7425,12 +7443,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7438,24 +7456,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -7510,7 +7528,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7556,7 +7574,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7670,7 +7688,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7682,17 +7700,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7700,7 +7718,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7715,7 +7733,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7728,7 +7746,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7742,28 +7760,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7777,13 +7795,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7794,7 +7812,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7803,12 +7821,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7845,7 +7863,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -7872,12 +7890,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7890,12 +7908,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7903,14 +7921,14 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, @@ -7919,7 +7937,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8026,7 +8044,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8133,18 +8151,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8244,6 +8262,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -8435,6 +8457,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -8480,7 +8513,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -8493,12 +8526,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9001,7 +9034,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9108,7 +9140,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9169,7 +9201,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -9178,7 +9210,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -9378,16 +9410,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -9396,35 +9419,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -9447,23 +9442,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -9475,20 +9453,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -9499,13 +9463,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -9516,16 +9473,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -9557,18 +9504,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -9592,2919 +9527,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -13120,610 +10149,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -13743,27 +10168,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -13820,25 +10224,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.3.0" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -13884,23 +10269,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097963", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9T5R43" - }, - "pspReference" : "993617894965500A", - "resultCode" : "Authorised" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -13925,23 +10293,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "024236", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9T01IN" - }, - "pspReference" : "993617894945494B", - "resultCode" : "Authorised" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -13962,43 +10313,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "048531", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9T2PF5" - }, - "pspReference" : "993617894954499J", - "resultCode" : "Authorised" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -14077,26 +10392,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "022966", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9T0BB6" - }, - "pspReference" : "993617894947495G", - "resultCode" : "Authorised" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -14112,23 +10407,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgBdNcOUwhrokraZtM/nJSduq+zXt1Hub2wGGxDvL/j8D63+t+oTWtpsKPus73V1DRhbeEsPDRc6MTCmNRFNlYzRB9+Qmedoot2ccLZvIeIp9JFNURi4eLi70MEjNsT0Me1nkbkkP8btIWrk5UzulQbYCPHUurWCXgIG84Nc5/SQH7t3cpVLWiZeuXDKTUiwFjOP05jgS96jWzZ9w8WYla+tJyOST94mC246dlveWuQCDb70MxoPVi9BcVdppUBtaIXPIXYAa4YbxLAHyi3lw5STnhI0y8/k3tc+dBAFL+vezYDWLZ8czUdl/uqDzsPEe/ewz6TyS9vXZvZOAjcJhJ4wDRwZ5AFQBRBNwSANMswOBXCyh/jJsp9ycJSAT+ahWmSWKaU4oe1jlWBmQ8rxnQNOSWkV9/ZpLsrN36eLCPo6VgQnNKhWx5zkkR5xMS0pVx+Ff7ZdFeKtl0Trc4OyON8lBHTFNd7Pyhl74C21dlZUNGxA5gIc1xNXNFOvCNJQvyO9sR2giM1dEAKXpOm7Ez2u7eDvlpQa2zwPxulu3vQ2xSDVmqboSPx6Wp7ywyiYIIJzUwphVu3IulMjWnmHQOTYatiO9l1O50tqepaFB3/mwdesPw1cJD6UYq+v8kshrYya4w4ojMmQy++0L8UxUBHis71ftJM+nIhXZBpJ3cXtehBMZx+06hofQjgUgsuP+rKKAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMiffpA9iAv0lzUkDkBzjQG0XzMpxNd9Z7Jl1zf68QhTbJ53cSWhqs9FLu4XbuwyQ3ie/rNaLX7uypr+FmxHIZgehW2wSS0XKs7qp6b6z9OiTbZgcUEVtsyZ/Il3HrI+PZnavI3MB//BC5kjX/KE56BEIytAmQIovNHW7i+4YRVCjpNKAuBLr/DcSkLSqTb7HwV51btGbyhB9NwwSqO2rHUwjl+2WScEkbd5b+EUxc0jN7gdc4mu96Ak9ATN/2J/AHoiEdXDaZRkOBU6fSYOEQKpXw1UW9SOJdUji1+T7b8uVuC6gXAzS+wUXkA4ZsvW9UM5yyhaF6UgF3jY700Ufme7r98pjdBydAGGWSNVu9BdZmzDEiUke0eL2k7rYv2IfxtVvyacVNKnYmwmPpWRqvxQF+PJN2KqcVEWbNal5fleujujNZ6LACeSO5a5eREJ6bmdyKR82So08hMEwV9Ky+Sb1REXAMXY3o/FvwzN4HwHNaqi2pYNw37JkLEQTEIeWntLyC+pvc1cVhILipMx2bbBCx/CijEFGJSxVzma1mhv5Q+RJ8XtaqyzJoFOkoIoy63cq6IVYHEy47vgCfKjdnK8jDFfOU4ONDjaTb01vJYwF3XnWxNFspb7oq2ZMbmBtLDGkERkMmcrZV4XIhzF3uhbo8PEjrFhjMepOT/gB1/Tq5XkUAIViviWYaFgGByHjwzFPufEdu4ycZiG5KC0MFJ6Y+T6YrF++U9FRmeJpbdfF2oOM5Rc4jqg90YI3fi7FeKY125Dnl/uGKJhI07uaf5SRt9R3xwJJgUsGadj/AL", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmQ*AuTBD0lKr9ylvSsHVa8vlWs2gBpsYhsU8utv4XJRVVWy1tbMandm12*KiXIrS6BVo2THRpv3SoHg4wwmRWa3oHjNhFlzLnthaA7a3F*wK5kKA5VippHCMWMHdHuXbH-8LPLXb8lDkqXbLzMHUBpvGpArncEepv5AtVGNqD4QplfihhlGVys3dKN4FayCIPSXyTXnd1PR3aPl3W6qh-bIwH0*RUXH63W2yZsz33VPskh1anmbF7L-k*mkfLT8Gxttt4AG29mfSwixFegi29HamM7y11gRz0FydqilNojEJCYI8Rr4u*yNrmXXgUJEgxoaDhqfv-6VTQWXLTrJoGwUcIPM4P4vd8m5B1PL0vJvPw0b1X0ct*WFah4DakNqUoeNlpPA5SQRwyh7tcCGHROjg-cMOo5ja9DTrJ-YoSkbM1KPeO6CBAsS526IjtwlhiB4sS9epj0pxqc90QQLTcrA1u*NmH9G1785g*dcVhGFURS5sR8453R49vPvYRkPY*LV69MrL*v6VJC0OO*D4*6Y3O2SCsaylH8BlM7anA" - } - } - }, "post-payments-ideal" : { "summary" : "Make an iDEAL payment", "value" : { @@ -14145,23 +10423,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -14299,23 +10560,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgCrbmh+OQiaXUY3sofxY5aXEujSd/zIwdZ/zDiV440FsfTI6tfDuXPzi9jOQgmGr5UFM7mnTNjHY5fwFD9FmKQre5ewthnSTsBVmC0RxupWRh7OeHYCcLp+G8+vxR680uJwp1stzdzq/lXmyIinV6aC22NzapolomfBvxS3cANwHE4IC65sXt5eyzItZbHIxJqMC7ADM/dX9Qw9HolgxLQXZlmjdHjfEHEmTvvPHXe5cBv4cfKPJ2gp+RH1J4hds1BJxKwobazQ+a/fauTj5N0a2uotli9I+06B5Y9fR8+SFyOIT3X2jHVDrGMMiVTjBSVDYB6/76A6q6GPXUv3cPgLBRdYOxKJewp5o7raTYs39Tp69iZTPF/9+E9TvmSIjcc5yekrt3kUUxnJTITAN5EJa2AnmfdJBro7O5c0C4OQ43MIgMhiMUKzBewWb5rDzfDiUCQKkSdWEbJUWDEZSS3TPChvP6smI8m80rbgig/0IXgt7Zc2UT1GLdai0t30AoX0gcnbZJnS+4o07WivKPI9aagD68dYJZy3VN64p7Q84vzj4IzwftzKW3lWDf2gt6Reo3x4Sgo2KzznEfCeSRB3QtK8Tuk5ibgVgjkCx2p7KaxKtj1Mqdi+DgA63sM4juy2IAf/23TA4fu42OWovbF9DmXf4v8aSvLmCw3NYX0VyxBEf4xCIC8T14KfCMGbP4N9AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifYDX5Nt00CX5QJ7OLRtmg5wXbL8+ctpyuEOjPJt2DpH30H0klwHPxbTfbVgctpO7GFGrUgl+mqy/pTDTlfKGmt2SRWGbo9cDMbUTrcKNh2MiEI7yOroy4iL/DYnvqbqQ3kQTjxtYtyM7qKI5/NbPotypE2Z6UlscFJnMYaaZCXenBnXU7e52p4tk1hQ5KkdZTbkjdZvNkEL7yGvoVgBNRPmTr7fZJib0XPyrAK76VL5yBq0A3mcwSMChj2Uu0ri7lp/g4yO1JNljWTxtEwaTCxGOY3tDF3IqnqELIHtZ3hyqG1n80muT4wVUX6kmCc5zeHybbZTJhPG2Q+fPAqvNXA0y4Zg3JOC51gGRhmN3m7L3eil3ks70Ejx6gpNzLnLZWpzZy/tff7coZGYW1Xo3973NOJcDkEA1QjhKiPycsHy3ZHZ04ShINLc2UssmV0o68FQ0R6sOVbjOevBaK27EySDaZfQnUjDSfgJdtIFDIEVzZtVyUWGo6w+cYLUYZCpeE9VQac1DinR/NH3w5nqHKyTBf9YqoqYZh3CuOA4jGbwadiG1HhAmZg6TOY7GZ+91hB1yOs4fsDfR42Rj6MEWOaqoH/yggwtjdNhdyeSIc0z3vfjsWJCLy4Uy0haQ7ww+81mqalJBILsTJuS3cwpuGuai68o4ApraA/8sXd+wJ7HBuCqaqJ1r9ZdPppgK+9QbZzGA8xvc5IzHqyOgPZ9oRCTbYOmENJO1grH15TyBHBB7N1Eu/76ojkCsdDEK/hu69T/jLin+x7X+aNuWVILJ4Je8HOdI8ddtr79R6WX88cU=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmS*4YGHXEpbemmvR6CK8lIZs8UoiU1sg0J*-RmaS6vTSchGM6vdmVlXArN6xWtI6lYAUWmF2b5ljUl6IYCRcebSMjePIAjFTC0J4T1TSQFSPV*xG5kxBY3AquXMUmMHyeoxXf38VRbvD*lLmmer-1YOIKS*Ew-d6Bw*YJoPiVRi0vNFqF6wO6xwEsd2YIdR7MV*HLjx061m0zZJ1W2bTf7juHfbZVFc3i77cdfsthuPxg8HStH51XupTvn5d1ca7p3Z4fEI2txx9mYjhEwBsszXCVWqM9yl4dzr78AJPlAulUYiFCENEQpkz3slKe86EBqRIIaWgNS-r59tM0b4UbvI4TNlzQz233bXmmdQlNeGe-9P0Frd96gNJxBzBFqbpiZ1epA-CfQnifoYeS8WemCH2WjpewYtyzIlyCnnN3xo61aNiYMce4G8BYoKO9CObF8ffrwzr16mHQlMph0lqW40KQNT6vcxv4qur6zBsa5rCIMwDO3I9axLNmzd4imoo2FMHbo8v5Oa0nOJsvLy4Z3Wp-RxnTYw1jX-A42b3RY" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index 128cb7a..f2feac3 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1567,32 +1600,32 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" } }, "schema" : { @@ -1611,8 +1644,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1626,8 +1659,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1641,8 +1674,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1656,8 +1689,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1676,8 +1709,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1692,6 +1725,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1755,8 +1791,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1770,8 +1806,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1785,8 +1821,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1800,8 +1836,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1820,8 +1856,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1836,6 +1872,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1890,8 +1929,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1905,8 +1944,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1920,8 +1959,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1935,8 +1974,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1955,8 +1994,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1971,6 +2010,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2044,8 +2086,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2059,8 +2101,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2074,8 +2116,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2089,8 +2131,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2109,8 +2151,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2125,6 +2167,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2198,8 +2243,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2213,8 +2258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2228,8 +2273,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2243,8 +2288,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2263,8 +2308,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2279,6 +2324,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2352,8 +2400,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2367,8 +2415,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2382,8 +2430,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2397,8 +2445,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2417,8 +2465,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2433,6 +2481,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2506,8 +2557,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2521,8 +2572,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2536,8 +2587,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2551,8 +2602,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2571,8 +2622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2587,6 +2638,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2660,8 +2714,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2675,8 +2729,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2690,8 +2744,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2705,8 +2759,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2725,8 +2779,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3155,6 +3209,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3413,10 +3477,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3642,38 +3702,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3996,7 +4024,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4025,7 +4053,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4083,41 +4111,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4322,7 +4350,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4389,12 +4417,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4403,13 +4431,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4423,13 +4451,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4440,12 +4468,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4454,17 +4482,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4487,7 +4515,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4531,12 +4559,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4549,12 +4577,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4562,31 +4590,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4878,7 +4906,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -4934,7 +4962,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -4948,7 +4976,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5088,7 +5116,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5238,7 +5266,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -5843,16 +5871,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6530,7 +6548,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -6549,7 +6567,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -6585,7 +6603,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -6612,7 +6630,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -6668,7 +6686,7 @@ "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -6888,7 +6906,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6900,7 +6918,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6925,7 +6943,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -6934,8 +6952,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7018,7 +7036,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7081,12 +7099,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7095,7 +7113,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7110,7 +7128,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7119,7 +7137,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7133,34 +7151,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7174,13 +7192,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7191,7 +7209,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7200,17 +7218,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7230,7 +7248,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7372,7 +7390,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7382,12 +7400,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -7427,12 +7445,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7445,12 +7463,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7458,24 +7476,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -7530,7 +7548,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7576,7 +7594,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7599,7 +7617,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7695,7 +7713,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7707,17 +7725,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7725,7 +7743,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7740,7 +7758,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7753,7 +7771,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7767,28 +7785,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7802,13 +7820,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7819,7 +7837,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7828,12 +7846,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7870,7 +7888,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -7897,12 +7915,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7915,12 +7933,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7928,14 +7946,14 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, @@ -7944,7 +7962,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8051,7 +8069,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8158,18 +8176,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8269,6 +8287,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -8460,6 +8482,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -8505,7 +8538,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -8518,12 +8551,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9026,7 +9059,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9133,7 +9165,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9226,7 +9258,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -9235,7 +9267,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -9435,16 +9467,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -9453,35 +9476,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -9504,23 +9499,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -9532,20 +9510,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -9556,13 +9520,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -9573,16 +9530,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -9614,18 +9561,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -9649,2919 +9584,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -13177,610 +10206,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -13800,27 +10225,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -13877,25 +10281,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -13964,23 +10349,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TI1O2" - }, - "pspReference" : "993617895005515H", - "resultCode" : "Authorised" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14005,23 +10373,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "089261", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TJ8Q6" - }, - "pspReference" : "993617895009516B", - "resultCode" : "Authorised" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14046,23 +10397,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "037284", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TD5G3" - }, - "pspReference" : "993617894989510B", - "resultCode" : "Authorised" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14083,43 +10417,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "034933", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TEMAE" - }, - "pspReference" : "993617894994515D", - "resultCode" : "Authorised" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -14216,26 +10514,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "021498", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TDF8I" - }, - "pspReference" : "993617894990511G", - "resultCode" : "Authorised" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -14251,23 +10529,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgCthN9/C4DNJMIhc+OqEtrOCtaSH2tFqeA5EC5R5qO7VGZzu21y8wnBMCEyfdOfLaVP96bpaif/3MZ9YM48N6HgYZ/6KIATkt/UOUjS9wIOnGIT8pxqh47FSjCOqmVQhWV7p+gB+w2Liyifl7gBCzmcewgp+NDMAHRB/RQKMzXkBT1B6Jv5DjHCVciK33seD0mxJdZ8xKzYr+BaU6OfKw/pm49D+Q7qCH6zjlTq5pdb137C/y4Eq+gglXZUYFblOFbP897GRlIWu5S2wOnKS1zp2pXVKH4dGu79a34ji1IJFLwUfRLfsojvjU2J5Q8PrwbSUT1Rgk+mklImuPH8t6dXO2nBk/Jky3w2JxrXIioovSlz2+slT28di1hsVUeDAnv9yKWagsqYvvUrS9MDoqO1xfsy62VlEEJTY/MCzqtq49nv0cUHoEKQ0xZF4r8bbXCfhV3/ZINynnRxXWrK5YOFE/ILVJWiEhq+95nqRIxu0Tc2cUEM4P0f6IskIVGqgF+AzqvQQzCgEBJiAbf/paGHeqMz0RX5VCPBq6kFt1Urhx0viuWPAo2c9epK2Wik8y3Q914UjMrtJtuuk41/hI7of7Wd8/zNshHf0gn8h+KH69bS2jZyo2ZtW9hteqBiYtHJlqDl/vO2D6Z+0WHB1ffUkI5Canw2JAUc5wwq3l5mZBDAVDRdCyZlexvkU2tZXkDHAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMife0UnvTuC0KkmKfgI1TES6l5nFhuOPE4VSwvurNlNe9CpZh7tTf2Hv2sS2POMgmoU43DvnOK8tSFYGqbtd2GHtBQJvxOlS5pc/2kreFfccgsd24Y9agn4XmeRdeRvk9FL4v+iB3an850gsOOXiHibuVTVCeZ1A7EZZFPm5ei2sDikUNsKdv12UZGEAggA1O548RtUFRopbDRpWvheSbz7lhsnDw5r6YO4NgKycoLtNho5TVHd7iQ4hK7bOclgyUU8CdGEo3LExOieBEt4zGahgKPMBuJPhNSmI5vIuz9BxdUMIGsTB5jhtHAGltJkqxjdQJTNE1i6/a2ZajgT/9GqRWZ7AFsxok7nvBv4qO7oss0grUiZDh+h4DxwK6wQ3A2smyuHKsRpqB/wcWjab2Y/NSyMhVe7ub4hiK7tyXCxU41HcPko6twA65ntb6RZgxzTykYZNPR5ZUh/MEorfpLVJ7OWB93NLk3aAH0whcpAEi4A6tMRdixVZLpXb2CTkeY+czRI3q49FOzTDHNr+SNzn8U73E3ILb5vn5OnDLjfCpU2MHHP2AyO0dbYPJZWNaEvGbhqzC3VdyXgeHjNdBoN5cWBZh+KeZobkmn6+PYreIWtgozSV8k5lUvOEJDIwk+jbdIelOfy07LkWdkNz8yhWqmoCagt5H+FlT/uLx59zcIp9nYJ1FFWI2OZ3D7oN3i3wTlqQDn2Zzm+dwGI6drzDeeapHrWE47zyzWrnI1nHG8PbJcldsrXcNQn6OqL4P/8YPF5/z1UW+QPLWEtM4rS8o8OD1IMULDC4ibIw==", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUstu2zAQ-BrrZoF6RI*DDoatJHKdxlGtpPElkMm1SNgiFZJSw3x9KdU1gqIAsSRmFrszuzzImpOlIJA1TIquNg7upQSOzQTmVem0IDGtuV5gLHqusx0o-XDBrmTBNTSy1kxwV5sOsuV9vvz2WO3e7vLveVks-5s5gFT2zkLvSpdwhLE-ZEpLxpsvhO4lX9W6ztLUi7w4ScM0SaMIra85P1iT3b2*7reHhKw8MOvweDRh*vjCf8WE7bV5SrZNu6Hr6ml1KvJZsHKs5RasuXby5iGEHAmqKjcZ1bqbBYuZf2vPWeD6TIXSFklQgiyEKeCT6LWioutAWkSBHBgGZZ-bP2ULjkVrXZRAmASsLTN4f8tdch5AU0Fmwe0-g7bqvo565kdyGoHVZqlRnW10Mwq8GSXaYEQv57ZhV3Pj2nsCXdd1FKhxzs-1mRGmTeYj35ujcI6SnRdZR1Pw071z8TLuSNZ43FGW20KjMnDUifHpV3T9wR1897KGOIrj2EuC0P0shp-Bbh2RZDC5Txcfb5hQ*lGhovo8hu*b9-x*kzdgCBG-Acrp2a0" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -14300,23 +10561,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgCNzlrqgBh3IfW+KEiI5mSYZyYhC4qmvk6ChrTHxEPRFGTYu/8zQz741YsRCVG5LZ+UkffzhZICh3v1yZE7CDOd/xcQgHMW/nExCEG9aGuWwrLYAI/mUKsD3l/NcTS+KbHExyc56HiWWvS9wjcceKx+l6vb8H7JYtRQdRy2dHktwqpigZrwjnbNcNCWpozyVpJe/DT5eNowle4OoT4ii9EbEwFvCIRT9bbob7O5Jdy68nd90XmStFMshZL3MVNeuFATrSyWuoAgMSJkfy0N/SvUlv9kWJxMvmFcPDTcR1uYRE7ugC5iwLZJuBF+zDb1h5tWK2XcBkK70TvzmLFrFsDn9NTeBwN0SmiPFOdxGVcEjEMQDK2yuGzUMOsIyvKhSFJmS3FVGujztxngvVA0XTcV3mVfh4JSKc+8t5i/ddV1f15wcYQmS7WBJPQAY2junKZOWZSMi7Dx5ViPS61OLhkrTcyS6PKsY4s7mohU5qEdiHqF8WRfdNag/5FRGGexCYGf2ewouGKduFtrftnUtQ410jN/TGYI/QS2Ay6eFpGXwH4WZEf2xpUXjHJnpQlPCQ7UwJUVCJYGd7mONUJ6MGJGw9CV4NF0nvx82hKdshDYfIzSWP+HIdBA92XZiqaQijbiTKSEduuf/0uBJ2aJM5k47btuc1aLAZQlrDS4dWLmFBAJANATc3sWIaOKbr/5X8Y7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifV/rgRI3Jh1fp9Tm3HFJWBK2LFjzVvFPHkJA6jPys0NuLLgzjEsTretHY+dBKZzr5WDJg8wtZz7j2BSgWAggzv9G32BQxasKiRIO0O14LPLpT3EAr07kVPOs2xTu5URyrImVSTQN+IG/uVuWhiaz6U9eqZkQq5OhSOMpsHah1ZaMRRE8S69RwZFYnak7YnjAj2SQ+epRLrq3PN4ixU7M0RZakUWHsqclQgHCxsqqE8jlfmV8YLcO5aNXgZVnq5rqWc3Pvg6dce5B4RoUKO4ZFcyW+25mnQtRGiwEF88UObsy2MgKboA7+PYoS/M1nmAPmKq/f8cUOxuYnBxBBu82Hgz5AJhPiTuH5jxLK2iN8yv6U3Dh4KqRHa1/sornSTtMjNhyySieOwK0o/lheD17m2+aV4b0Notnfgce9MTb7Jg6cbr0b7iiUMV6k+cSQcN/gVtwZ7AxxEwZPhARhu42oEFNArmCzB1y8tnAFVx9TY3DH923Bv0sXg8/a+cjdBeZ6ukctpyMivHI3colbqRR5fIQQ4DCrbWHuQY/2JZLgcfd5vPff3X/isV4EWCWHJItvGTqkKLneb2He82KQuqcrRgXY6R3RPVtYaeWuiJSiRdsUWnPe5lkGXDaL7y706hAbDkeY/8CmuBNkfZKal+iSpVEwmntzWsM1jdjaYOuSqmD96ht8y92BCYq+qA/hjsbjs+TDiAmS6pd+k6o1VlVkc4Kyz9kQbrZc5nAtgTaKj+O0H9uQOGj2jPW4t8cBVFnzwB6GVuXDS5nFJCeb4kavw/paKRht4s=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUlFvmzAQ-jXhLcgGCuTBD4zSlibtJhqmaC*VY1-BSrCpbVjpr59hWVdNk6y703enu**781FTyXPFgQgO9OyxQWuQbFqgoq48YcwAuuQE4wB7HWjWUmkzxtQgLdmDsQ8X7CNZSguNplYo6dupB5LfFfn2a71-vi0ei6rM-1s5gjbOk*jvlApeYGYDxFgtZPMpYQctr6mlZLPBMU7STTQHcZB91DyJhpTNz6nP1GG74Wle6afb9MDvt9svp*hxd2zjoxhyxOKuiGOzCq*9nk4dOHHdog0jhDwNpq52pLW2X4XZKrhx76wYPbfKWIekKEUOYi2wkxqsaVXfg3aIAT0KBsaF3363LSVTnVNRARcamHWZEf9pd6l5ANsqvgpv-lm0Y-d51asg1ssKHDeXmtm5QVczwauZojOTGvTaDeypnHznF9D3fc*Amff8nZ4FF3YiAQrwGkVrlO5x7BQtJsQ-vIuW*UaasvlGpHCNZmbgmZOQyx-ph6M-Bv7lDEmcJAlOw8h-L8dDuL*PeTpORdBmb8*Mt*1bjcr6-SV63b0Wd7uigYlz9QutjNyJ" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -14454,23 +10698,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgAvIvdVPQD6ljxrC66+FwR0FaxDspHFSr4AyJU3Ceh7lGVk4YaklDVlkXziS1wmSkEIHV90bRQt9tggc/UH1Z9m0uzmx4ZqPdNYCd2I7/l+w0Hstk9/Q5nPTqF/NJUqBPOULOROo2fQRQk9e1Nwlk+hkF5+FBPbX+qfXbIjX2GGc7h/rHXEZJEwWe1gz6Cca3Kq0eDp/lY9zA99MnI1qpZxw73trRe4OgSYXw36kyUiUb4ik197gvekCdd7cjwDzP7ZiHAp+qPKDJPzjjNQNAN/+RWdMva4KdOkycUA7W18L6b5PCk8kddUU5eKQtFMzNoqBPhVvBcPkrsPPPVj0Z8n6bzT6vFdJu2/SDM6Xj+mx1G358d2SkKS0Q/cILxt4pfCVFTFWF6zy4sirG5Pc7Vo/KIUyZxAFV7Ud539NaRVNCYY65KDRXK/ANIcvQSxp0tqGUYzsvAqmp4KQ1MlfZzcxA2JtR4MdAa3SSc8D8q7PdgPVsPCTgN/TbfPQxDalOgY4zJAVoVre8GlvPd7qKjU4Ct6q1qoqcf3mQqYrbTWvLTLDlpHu/btAJrbh9aVKc7JRGM5xaGWPAkclGz7Zsbb/WIXL7i38e/icf0/oWtwXtDsmBUZcgDD+I+8zUW9+3iTeJtXzPjJtlLoJiTWCePpO2r149fwG+xxLi52d69cwxDF6d4B/LTFEjDsyVmmmpP7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifQmQ7pxA13nYmt54YOm1sEPteTnbdkD6S06nPPQp5kpNdnJrkdFdZ2SsnXIHDNk96S7mt248VYMOpL/y+GAQEw2PBYXRAUMEm3737bnbPmro9cICPuj6plkXLkQs3ZFchEQOyrNIoG0z5u1N48bDie8mnb9p8jpTNw4wxfQpN0sINQ3dqu1+Wt1imG49AjvP+7yEJ4Nv8DDpXwZ6A6wQZnZYuP/XTcbsIw9aJxRZpqyp7nLsDry0pPCkMXfdF87GYYo3xzmy4HdhhbEh2jXZUwbEVW6onalQu4StL0OJjr1WM7XwG/SmHEfZMvjSvUcCEPT3FcXCGA8vaDkyqD4dS+16qlfkG+t4YWf32OVFCSlLDie0BdeMoEePXCkU63qWCY8qGde4NVjoZCt68HyOdYhOZ3QL7ssBYfiCOBYWDnrPUK4sXxBaToEt0Cf+xHnCfJ0CklxMXsh3hEhKLyCbO53uB0T/eYaKEqw1SnoMECNSnkA+Qk7LVfrDZTnFO9c7op/wr1bTjSW0r7eQQhiuLGwwmGSGiueKB0FPt5VVUfmSXMW6s9KRqYFUEjDyKv9g+/ZaiRIS+4L7P7YWuQu+Lo0BvvMPxi2EbCfPTv7wRsZp71mSnJd1Igpjip9itzeF+ZteWFkmvMrVT8TQmxl5AvcAAnyz7yBXgH5sVGV9Up+Eu/XJ/KkzF6X60hcFk0eMLCFA/tr4ejMoSS7Wr54euCmlP7sy1Fv16SZtZkaO/Hp2EaCOIZKhIHOiVEV8tcq9+LZIcYvKVf47F52/nAjc/l+8+dwA83957v8WXhQ=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmS*yYMfUEJS2vRy5cLpdC*VY28BJdjENlzpr6*huVxVnYRsNLPanZn1URLOVoIBZo0EqrMj4aeGVzbtpQROx5nLysJuQdKacJ1SKnqu8QGUfrxiNzLnGipJdCO4o8cO8OouWz3sy8PzNvuWFfnqv5UDSGVuHLg3uoAXmOYDVlpOev4Rupd8TTTBy6UbuXGyDBEKoijc3Gp*NBXeNvs*TNb7P6d9pZ7YWQTb2CUrkXX8-qFPL22aRE9BeFHHk*Wv7Y6MLRhz7ezNRQjZElRZ7HCtdWf5qeVtzHcWlJxrobRBEpQgA9Ea6En0WtWi60AaRIEcGgrK-H7-aJtzKlrjooCPlA0zuH-bXWseQdeCWf7mS9BG3eeoLS*ScwRGm6EmdWZQOAkMJ4nmGEUvF2ZgR-jomHsGHcexFagp55-k3LBGj9hDnrtAwQIlBzcyjuYjCH7bVy-TjiSh045wZhpNysBW5n3Mr6Lrj87gOdc1xFEcx27iB85bPvzyD-cRS4Yx8*r09Zmyun4tUV6*vQSX3SW722UVjIyJdwEe3Bg" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index c9a76ca..7dbf0e7 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1567,32 +1600,32 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" } }, "schema" : { @@ -1611,8 +1644,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1626,8 +1659,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1641,8 +1674,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1656,8 +1689,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1676,8 +1709,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1692,6 +1725,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1755,8 +1791,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1770,8 +1806,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1785,8 +1821,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1800,8 +1836,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1820,8 +1856,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1836,6 +1872,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1890,8 +1929,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1905,8 +1944,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1920,8 +1959,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1935,8 +1974,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1955,8 +1994,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1971,6 +2010,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2044,8 +2086,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2059,8 +2101,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2074,8 +2116,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2089,8 +2131,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2109,8 +2151,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2125,6 +2167,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2198,8 +2243,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2213,8 +2258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2228,8 +2273,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2243,8 +2288,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2263,8 +2308,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2279,6 +2324,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2352,8 +2400,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2367,8 +2415,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2382,8 +2430,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2397,8 +2445,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2417,8 +2465,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2433,6 +2481,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2506,8 +2557,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2521,8 +2572,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2536,8 +2587,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2551,8 +2602,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2571,8 +2622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2587,6 +2638,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2660,8 +2714,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2675,8 +2729,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2690,8 +2744,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2705,8 +2759,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2725,8 +2779,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -3155,6 +3209,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3413,10 +3477,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3642,38 +3702,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3996,7 +4024,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4025,7 +4053,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4083,41 +4111,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4322,7 +4350,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4389,12 +4417,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4403,13 +4431,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4423,13 +4451,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4440,12 +4468,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4454,17 +4482,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4487,7 +4515,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4531,12 +4559,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4549,12 +4577,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4562,31 +4590,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4878,7 +4906,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -4934,7 +4962,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -4948,7 +4976,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5088,7 +5116,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5238,7 +5266,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -5843,16 +5871,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6530,7 +6548,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -6549,7 +6567,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -6585,7 +6603,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -6612,7 +6630,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -6668,7 +6686,7 @@ "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -6888,7 +6906,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6900,7 +6918,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -6925,7 +6943,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -6934,8 +6952,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7018,7 +7036,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7081,12 +7099,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7095,7 +7113,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7110,7 +7128,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7119,7 +7137,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7133,34 +7151,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7174,13 +7192,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7191,7 +7209,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7200,17 +7218,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7230,7 +7248,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7372,7 +7390,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7382,12 +7400,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -7427,12 +7445,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7445,12 +7463,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7458,24 +7476,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -7530,7 +7548,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7576,7 +7594,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7599,7 +7617,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7695,7 +7713,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7707,17 +7725,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7725,7 +7743,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7740,7 +7758,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -7753,7 +7771,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7767,28 +7785,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7802,13 +7820,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7819,7 +7837,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7828,12 +7846,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7870,7 +7888,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -7897,12 +7915,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -7915,12 +7933,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -7928,14 +7946,14 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, @@ -7944,7 +7962,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8051,7 +8069,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8158,18 +8176,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8269,6 +8287,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -8460,6 +8482,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -8505,7 +8538,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -8518,12 +8551,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -8819,7 +8852,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9034,7 +9067,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9141,7 +9173,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9234,7 +9266,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -9243,7 +9275,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -9443,16 +9475,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -9461,35 +9484,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -9512,23 +9507,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -9540,20 +9518,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -9564,13 +9528,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -9581,16 +9538,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -9622,18 +9569,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -9657,2919 +9592,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -13185,610 +10214,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -13808,27 +10233,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -13885,25 +10289,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -13973,23 +10358,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "028422", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9U0CNK" - }, - "pspReference" : "993617895052526G", - "resultCode" : "Authorised" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14014,23 +10382,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "035999", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9U1A11" - }, - "pspReference" : "993617895055527B", - "resultCode" : "Authorised" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14055,23 +10406,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "001656", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TSNHF" - }, - "pspReference" : "993617895036522G", - "resultCode" : "Authorised" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14092,43 +10426,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "001872", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TVP6M" - }, - "pspReference" : "993617895050524D", - "resultCode" : "Authorised" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -14225,26 +10523,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "028065", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9TURT2" - }, - "pspReference" : "993617895046522E", - "resultCode" : "Authorised" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -14260,23 +10538,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgCnd3nrbhA7SggOHNrkA+kmUK+Inw+iAv3kN5PGTwb3PVrpo/Qjp2xTh0HGwViCU1Rd+7jnTO+KcKQJw8vKrVu0DkOajmAOKP/4RgE2q4VBZfjtLyPAUSRdkzAEn3JR09jjRmIoeI+dYN5l8HP8cMoUBklJ+bHAmC++c/hdTB8d3JIAttj7qrjR0/MYt90SW4Ncbdy09fxwn16FqDzFkHK60be0oUXIoe9MHeeuadibcDT5yi26L3jAhjk+L7j6nk49UmYXk+7/iRJp7AufX9cXecr1MuaJPD7eMw8eK6lotHiQfvu0P0O5TEqoX0pZERJUat49K0qUESUjqoYvQU24Hss1yA5NLulBzRExOuH4DjJGJYBP74hHDCwy78pO58+dahMp2Pfwt/HQaE/X/THmSm6kjVE+gstURYuk4wcbG6WaE5x63f77xvBD6gabCpgc9kxK5twspn8tfgu10EJuoDfSDPE/TgM752u1j0X1PLOtddIzVKdbzrjGLb0SgXp2k6JMcmVIyJQbkyl3c50zK4tW6TV+pTaPjB9tsbIXjZ7f89I9eb7xYB9koOKwx7rEz+RSytPfABUToIyFTs34G/7mVvz84WD98H9PTAbJayGST8+6NoXQie9ILo7DF5Qa7/BitURng0RataHwdckxRlq++HsR6jwisuqd/mu1eBD9dOxH/pkQDL2lNNABl6uZAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifT4RAUv3gmWaOf8wZ5jZ/GcdmZDC2IUb9oFmkx3HlArQhey9K60AaGwGA5dYeG54MXcIvslrfnaiTG1NswXPMMVTplyazDl3Z/PzjvS77WEyUpVSC+R0O4krlCvE4ZEEbVXN1ukMaIq/W5FQGlYYCz41DKi41At5ACSy/nBCoNC0wpYy+lJgfxiNhhUmQC1U86a3PXLBkuxsynQFySHJ7yJffasHs6TDV7Y4hmhjN2jz8ezpik8ZCWz8Fc05rWfpLzU5lxaXrjy/xcG765nEcG9pv0H6nslcGdTbU+JKEDJ8ZXw8USAlpHF9zvHnTPfn/u69VdcwQDiVLJoymIllVamJzNPrP96vCnV9MYXFWt5RMTmjXVptZDLFCQrwKH6nbqZ5f4r0q5JaE0bbhVMN1mrvaxblLj6Eu/XWoZUgGwWkMSnJWLqNckzhdMzKZ049aflCklUWY2rTvI8x/2etdne0EXU2flQJSXBICut/3LzyN69/Kd3X93jicdq41yXT2D8StfiFnM11QVnAr8Vtz9geCMsTW/hYI3UAFllfdGmoWnasa4NKTPMOGEamxu5EevrkiI1KX1hV48otTawDy3cfXwWBjh3BlL9iJhExAFF51y9D8T1bd0+U+s3uXnJscvgvl2xq1Re4A5lMcOe6jCJTy2xnqV8/cKpy/TV2z6MFpQW19vYZpJQeJ9wDc6UAbntxpOlTQ4puksN+fiexxUM7EeDyIxnT0JnMTql5Yq3iw0Wn1GTEe7WB9EbytFscI+dmc9yWrad4MLA3m8LG0ZKDPacqt/+pucBJyMg=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttuozAQ-Rp4CzJ38sADSmnCNtmuKGQvL5VrJsAm2NQ2qPTrO7DZqFqtZNnWOeOZc2b8IimvNqKCuG6l6OlkskFK4GxawLTMzQ4kayjXCWNi4DouQOnDFbuRGddQS6pbwS099RBvdunm4bEsnrfp1zTPNv*NHEEqPGMvuNE5nGCuD7HSsuX1J0IPkt9RTeP12g7sMFr7xPWCyEtuMU9tHRe78zE3nPvfh5-q*3ZXquz45B8dRLpH-yHanhMOVKmkDBNPnjzDvTPRdgdosFv82YQQU4Iq833caN0bboKPcV0Eo5dGKI1IRCKCEGuAncWgVSP6HiQiCuTYMlB4-fYnbcaZ6NBJDlUrgWlkRvtvumvMAXQjKsO9-6fZqO5zuw0nkEsbUBtSszos5M8C-VkibpMY5AoL9pRPFp4LaFmWqUDNvT7SS1u1eood4tgr4q1IVNgBOrLDefN*mVcv85wkZfOc4hQTzcrAVOeWLz*jH16s0bGuowiDMAztyPWs92z84RZfgioap9RpkrdnVjXNW0my8v3kve5f090*rWGqKvEBGEjZqA" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -14309,23 +10570,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgB6BPOuzRMSzFbUouPQm0rkDcsOz/ShiXL+9a/G8SHUvIJGDRCPSuZsQkEMf56P3cGm/3FyB0C5J2SRcc1uTDrRMhagQoNpoTqTpBikufYTwHBx2jub+FpxZz6m0GKu05f2stJAS86Wq8FWH9QWjOyHt4UDsn4E+hlZiL5wus1caD8G+0qOrTS+wBOpigunCv/y1vqjLDGG442BAsZKCxVHyYGc8UIRDsXcA25w8knzNDGTUsNnqC2ixtWICjpV48u5jrbZ32MG6Mpr5eH8RkidYRgs+P8Bz49HYs+vEKIqORrBQvxR0D2qOaIXDPD+OIZ7MLUmUKhoco4mXDNvz6+06Bx6Xz/8hoTheBtyF+UA6f/oNywvPdy0J/vkTVDH+m/M89TtlygK6A7dxIOu8i07CpqRXsUNE1v+XTJFwroGC8kBu9Un+1biigP+UwPiiCh//GHZcXYVBVtNY95IyQGSza5fTAc+cbR5VAB0G6yfeun/yEwnK203ozs6j2IRizVbY2BW4BGIRIVg7aXmJR7c+jEOcWhQcPkmuk+n6CDzr5KUeNqKhwwXhXQ44ps76cH3ri7JhiSdXRJCWsr7WRVe2ceyxFHzzJVvwpxmA8J6e3rxqztCE3et0TU5ugeHWKZaFDJk48qfdbcoN+Rc1csJTWZ8X87kJvbCuInYY7wu1BDDIiKDwTm+q9Yo5cLtF0K6AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVeD1kKJyQisqaoEe6NRfK8FyDXGlod6FvxjR90eXGa9cYfPx9XPNNWrxB9zPbE5HpGP9H0b7+l5Aavws5V5GgaOaS02jz6IuwqXbEfX5yYfpiJVOw+No5NeEMzo2VHWv+WslfyAAlUCTb9W1rskUpjV3EqNxchNPJoiMGLwEMODChGh5Sz0DQBfLuREena8IzExiWbAfC1zTP4fZIy+FKvk8MqRNgL82Eq86tss4jvP/WbZqG4CFGqUIE0lVM2KeFl6n4JIAaAb2+eDXWn9e+u23K5k9muGW8Y11lZhKSdDmY+U1cs7C3Qci+4NMP9qIaI+SZP7I/pXx4YArwmVNHVQd/c4RkNk6GitZg22G1xTPbRcVQkkHOT0No/inmwVOau33/l5SKlill4t2EDSC2VmQ+45P5zre9RMAXDLO/MMwrEHhdbSevbQQcKqLaU+Ndrm48EZlTqWxQbBOVXOiHzxwYaBu3U4yCghuSHgShsFZJKzjScBRGxFvVXC/x+NBVeHf0yXYBfQq4SW4AZz4kLDUAaIfWaTclGLCn9gZGh/PF00Sxzc/Rh19dlBB8xSByiwMyz+iPXONDLjnCu9PmrjooaXHvgNSGyupXsR78kfEIBticRzQDhgfNoKlWfvOZeAEaAhGtKZKAWQK4dbwb7bI0enGCICQe54inFhZ4oo+fFyp7V3SI22MtV5Lu2558JJiMfXyZOLLaFDiXjvAVyslBHBUPePMqsSkELcqQ+GOybXpdOOtxvCNTBBq8Qbj8+80a0DmKIA/CfzOIM6NECPTb4TO6yV/Q==", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUtuOmzAQ-Rp4C8JAgDz4IRfSpU2yLRt2276svPYkoCQ2sQ0K*-Ud0jRarSpZvpwzmjlnxm*aSTFXAmgtgB1d3moNkvdXKCsLtzamBZ0LSkhA3BNoXjFpp5yrVlq6BWPXN*xO5tLCXjNbK*nZvgE6f8jm3x7L7euXbJMV*fy-kR1ogyeN4jtdwA4GNUCN1bXcfyBsq*WCWUYnExKTJJ2M-SiN0-HsHvNU7*lx3G2i9a*YrdtJdZ4t4pcyfXmc7aKDEyz19CmMLpvFj8nyjM*85E64cBvWnwANnq7*iO-7rgZTFitaWds44RRDcR0VZ8dKGYtI6qc*QrwCflCtNZVqGtCIGNBdzcHg9fvftLnk6oROChC1Bm6R6ci-dLeYNdhKCSdcfmo2qvvYbieI9bUNqA2pQR0WGg8Cx4NE3HrV6hEWbJjsPTyvoOd5rgEz9PqZHWtR254GfkBGfjTy0y2J0RFJcAvS3*7NyzAnzfgwJ5phokEZuOZQy*s-ado3rwu82yiSOEkSkoaR9553P8Pt11ikXZ8F1fTyykVVXUo-L9930Xl1zh5W2R56IdQfUJTcug" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -14463,23 +10707,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "value" : { - "resultCode" : "RedirectShopper", - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgA0E+AKzHxD+sKT+0Z5agx5dmAxTdj+3Nlc9Uq/2vXU5QjEcAdsigMc3pZf6zcsiXr2FfbNBx0fLR2z1pjqPx0ubTObecUYf/iZag9GcjF2MiVvRFTKveTylXp/rZ9hT8pCEeE9B6k68ukdYV5iS5e5ByriTqXgNJzKLVAuTIdUQ/ZjUQweG6zrCDDiC59giRLlL3bQBJdZoi/i06W1liqqZwX2Z9dQhZtek7awoZNsh/a7zL9nO+ORhUmucgzxRN3ICeY5hEGBrPjPhEi8WsR7vS8LRhCqCx6aU4NvMaLYQQZMDhA6/4wvoV9q2or0F+mdGnQFP/Uj1dor6HXqgnCQmUHLejsR+uKJ/4bPc32xYCBUSlnZ8hC3Rb+SO+Nwxm+VDqfJJC/UQNIdw9v9jH4PAoVoJcGqAw6b/ObNush8p/iTvnw08x1/7S68tuUBoqFUO1WKi/ldwD3I+hLuKVClvuKsFsD4fBbRYPPTxpi+UccalNeBOq3Na2i4by4u8l3T4dxDYn96YVpqrigjv1IISOlVk6ijQ4onnnwLxK1TfyV1NYrDuQPHEgBVWx4U7X9dqjXlQ/NvZes8Udy4ShFQamYYRPgVM8PgfjXRe5QycV0ftGwkkFRJDq/QGGungDvYL4Wp/SqujhCkFMow5Fg5ytW8HxL5KnFUHqvp0w1cohChqmPg99ConXap6QxJPRC/AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifb6WqW7iXMtVX/eLf5zAMcvTtwRWv9BMdAXbktk7amecV0FiDoq+TRYnuiYSL94cLrQZmVp1ZRgmYOXI+/39dzKCW8ZfGI/QDcTxmLUIdv0rlb8/3alEaLKb4NTS07WHwc4yG7QWGlFebhg2byR1KrskyJY2U20q0nnP8VHIhiWzWifkCHfEKTfmUjST0nQoPTfAL7ylf7eBoE9g1yeW75lB9v6OIFvXN1uXLfyktpF+/oID835jren8XXov/+HBhOnQftVMROsM+WqKjYT0RlUSW5YzYoWA/EatGLCyJaVg4MY2vQMQgVY2PqfO/pEpIvpTxVZmsbabeVIKn/JrzeBli3byLPOuJJaaQ1dQ4R9qwv4e4DfFQg7jRtmncxmlZWqY39TZSq2Vqr/2aWPdVz4ypqC8T3WXT5vS0IiaACN8cGph6bJNcVLZhz7MiTROsUE9CL6l4338srPHYukzdwMdvJ94VR63fj67cM3QLjATdvUG7K0Hr64rtZ/1wV4pK3mM7AKkqAfVGqWAcOIW3eu+0MICeJe9m2ZDzlFekaF+o3K8U7X52COKLo5kM0qaRUuh+pu6JW17HWCgh+l61To18tm7mqP+jSlMN9guRr8VCrnk8vhxhEqWhNM6u3wKThktBz8j8HT9ri2lCMVCtfD1AYhNKi24vof1e6bDmwUn4uvIz6C1AH3hovoXnexJphUcdPj5wlbL6IWZMLDKIL0wDnmUzaFxj6YpUfbxRVjb3BRRhYClAwL0MqpQOrc28VwyVCm2H9Rob5kUIwQwrhnO9Kpx/9CaX2fQzgSXqQ==", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttymzAQ-Rp4M8Md-KAHh5CYxEkaCmmnLxlZbCwmtoQlQUO*PgtxnU6nMxpd9uycPXtWW0VFk8kGSNMqYCbfUvHaip3NeqVAsHHG8rq0D6AYp8KsGJO9MKQCbe5OsTNYCAM7RU0rhWPGDki2zrPbh7p6vs7v87LI-ps5gNJ4kjA*wyW8wFQfiDZq0vMFmF6JS2ooWS692EvSZeRGYZym1*ec7*2ORP7jPrr19FgdIUsuuOVfMe-H7wfLv8i7TC2bZH1zv8EXr6ONNvGjFVzaHR0PgC0e5g4913VtBbouN4Qb01nBCllw7SWjey61wUjqpu7EzYG9yt5oLrsOFEY0qKFloPH67ZO2EEwesJcSPr1GZPD*0J1y7sBw2VjB1T92o7q-Dbf8WM1GoDaEJnVYKJoERpNE3EbZqwUW7KgYHTznoOM4tgY9uf1E923TmpH4ru8t3HDhppUXY0deglsQ-rJPvUyTUpRNkyI5Ek3KwNb4S*a-0fVbZ-Cd0zCSOEkSLw1C570YfgbVTdykw5j7fPX2zBrO32q3qN9fwuPmmK83*Q7GppEfgFvcYg" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 37598c7..52622e3 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1567,32 +1600,32 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" } }, "schema" : { @@ -1611,8 +1644,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1626,8 +1659,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1641,8 +1674,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1656,8 +1689,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1676,8 +1709,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1692,6 +1725,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1755,8 +1791,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1770,8 +1806,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1785,8 +1821,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1800,8 +1836,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1820,8 +1856,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1836,6 +1872,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1890,8 +1929,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1905,8 +1944,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1920,8 +1959,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1935,8 +1974,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1955,8 +1994,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1971,6 +2010,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2044,8 +2086,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2059,8 +2101,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2074,8 +2116,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2089,8 +2131,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2109,8 +2151,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2125,6 +2167,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2198,8 +2243,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2213,8 +2258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2228,8 +2273,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2243,8 +2288,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2263,8 +2308,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2279,6 +2324,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2352,8 +2400,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2367,8 +2415,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2382,8 +2430,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2397,8 +2445,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2417,8 +2465,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2433,6 +2481,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2506,8 +2557,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2521,8 +2572,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2536,8 +2587,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2551,8 +2602,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2571,8 +2622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2587,6 +2638,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2660,8 +2714,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2675,8 +2729,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2690,8 +2744,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2705,8 +2759,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2725,8 +2779,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2885,13 +2939,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3163,6 +3217,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3421,10 +3485,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3650,38 +3710,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3832,13 +3860,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3926,13 +3954,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4000,13 +4028,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4028,7 +4056,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4057,7 +4085,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4094,13 +4122,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4123,41 +4151,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4294,7 +4322,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4304,7 +4332,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4397,7 +4425,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4464,12 +4492,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4478,13 +4506,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4498,13 +4526,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4515,12 +4543,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4529,17 +4557,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4562,7 +4590,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4606,12 +4634,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4624,12 +4652,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4637,31 +4665,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -5242,7 +5270,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5389,7 +5417,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5403,7 +5431,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5543,7 +5571,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5693,7 +5721,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6005,13 +6033,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6034,13 +6062,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6071,13 +6099,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6104,13 +6132,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6243,13 +6271,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6338,16 +6366,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6611,13 +6629,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6645,13 +6663,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6682,7 +6700,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6692,7 +6710,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6730,13 +6748,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7018,7 +7036,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7066,7 +7084,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7085,7 +7103,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7121,7 +7139,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7148,7 +7166,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7204,7 +7222,7 @@ "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7293,7 +7311,7 @@ "PaymentMethod" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7432,7 +7450,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7444,7 +7462,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7469,7 +7487,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7478,8 +7496,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7513,7 +7531,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7570,7 +7588,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7633,12 +7651,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7647,7 +7665,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7662,12 +7680,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7676,7 +7694,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7690,34 +7708,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7731,13 +7749,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7748,7 +7766,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7757,17 +7775,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7787,7 +7805,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7929,7 +7947,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7939,12 +7957,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -7984,12 +8002,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8002,12 +8020,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8015,29 +8033,29 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8053,7 +8071,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8128,7 +8146,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -8147,7 +8165,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8179,7 +8197,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8202,7 +8220,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8298,7 +8316,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8310,17 +8328,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8328,7 +8346,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8343,7 +8361,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8352,7 +8370,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8361,7 +8379,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8375,28 +8393,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8410,13 +8428,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8427,7 +8445,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8436,12 +8454,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8478,7 +8496,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8505,12 +8523,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8523,12 +8541,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8536,19 +8554,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, @@ -8557,7 +8575,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8664,7 +8682,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8739,13 +8757,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8779,18 +8797,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8803,7 +8821,7 @@ "RecurringDetail" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8898,6 +8916,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9089,6 +9111,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9134,7 +9167,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9147,12 +9180,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9395,7 +9428,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9405,7 +9438,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9436,13 +9469,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9464,7 +9497,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9710,13 +9743,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9734,7 +9767,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9783,12 +9815,12 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, @@ -9816,12 +9848,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -9861,7 +9893,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9882,7 +9914,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -9906,7 +9938,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -9927,7 +9959,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -9969,7 +10001,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -9978,7 +10010,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10012,7 +10044,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10022,7 +10054,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10050,13 +10082,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10149,13 +10181,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10202,16 +10234,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10220,35 +10243,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10271,23 +10266,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10299,20 +10277,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10323,13 +10287,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10340,16 +10297,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10381,18 +10328,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10416,2919 +10351,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -13944,610 +10973,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14567,27 +10992,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14644,25 +11048,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14732,24 +11117,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "039171", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UGIA1" - }, - "pspReference" : "993617895104539H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14774,24 +11141,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "056319", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UICT3" - }, - "pspReference" : "993617895111540G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14816,24 +11165,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "071717", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UCJBM" - }, - "pspReference" : "993617895090535B", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14854,44 +11185,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "034052", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UEDUG" - }, - "pspReference" : "993617895097539G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -14989,27 +11283,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "026523", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UDGL3" - }, - "pspReference" : "993617895094536F", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15025,30 +11298,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "value" : { - "resultCode" : "RedirectShopper", - "action" : { - "paymentData" : "Ab02b4c0!BQABAgB0GGL0YONwvtT7avYeWcADNdByJj4DWcbKRhIcKNkM6pNv/qTpAj2bVRJpBnbMGC7PW0bf7GHgiFlCIBEoLbokvwkjZkjFpYjhRgdAd3/Tu3ARSXC10Z93sXC8ARJNoS9nAYiJ0sN2A+YUb5Re3H3PAf+JUww2RTw8j5ewpZS7R7SoOdWLRB6wADekDKpF1pEn/wZ1iggdVDUbC6yJu/kMI8rHSpXMXGt3mJwICndP5pj2ZTZ4oZKQuW8inIWioHEChnoBluVh8vR5v4O5m7x1qHUI+KMKmg46XCRz4HSeyZSSt0i/YEtmAc2CvJBOLnfNBWjEU9Q9wz7XUaqhdyJSLhxfiGmNqMXlOR5CP3hIWoWzaSxjBGxj7EHyEYH+APgTb6DSTwFcwdUrRKNiJbXT7TcxvYp2oWy6+8euOEyvQmBGStilH8HlZ/evPw1ETL/gH9vb0cltE9g8BXtT/zVftwgElIB8OUSHqSajwbr1ixz+84ceFB6qxWkMKaoA8exrOv4xW8HkAbD62HQWkORY3CWW6+Azn/1jM60VRAUjFxhOJrPGRjR6huaJuh8+B9+KhofihfpwTPQKA0DniZmkL52NFqPW6wHI3siWycd6bgl6NiMUm1Ay1hnMGddfFg7/mijYOAGxHloCrxGa61VdLJRDxnTfKDUzWXqv39hMwxCg7iZZe7JoYWSfeJdjfo+PAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeBfB4hwExhN4+D+GEuR+ULSZhV5dUQ+HOIC/Bzwak/E1AhOZr5O+F4SyYt4NMhvm89xpP3yiFEYDyAE3kLjBonTZupkZkgmWmOmm1/C+ta8/tykMBVAusTSQ+1GeSmPvO7L4a9AtWek8OjEx4TLd4779HQpTGIWCqY19x4dh4OJM6vTqB57yS1fHvp/Y8RHwgrRUzuqCmZ+ERPBG0+3kqy0XeA0mwKf6MMy8yEwlYOAio/9qO3+XNofeQc8TuK/5vuGxd74nf29o9vugQWNShqKt/ITfmQp+uO/kSynDJnE/RVRLf2MldQfEVxQd9WKGX0bCkJP8GKPo7nWfzwBQ6+OqxdRT00N/tvi6ondb8RRH28RPktJGDfQ7GH5D6H7V4yXWhQWp6CXRF8mPaWwQV3lZje5WYRk4kgmGDKTja2ohNR1YFroQbg/TA8k67TIXqFqYyGdH5l5eGWKVPDJawHuQl0ctVwDAL5TCieqE0IcOHxEuYTsZt3oqw2PetNxZB2QtSHiB1az2jydwh5xv5KAhi3sOW9XdvS8JbgJuzRQpS50PEc+o2S79pv6q+XrTYma9DWNNg14wwhCTxZJQ9vAgZ/1wQwosMf957SKq7qaL5y0Auhan+HX3IbQ1qcyIUP/fiR1qAthLqvOu8xPikV/E7Twr+e7OBGeAFNZouJEuEr4DXLLOey6QuOBeTNaIk/sGur51RMDZ0FptsKGY3HzkatxcPmGBFxmcdPYjoxA4kiMcUBywdXnxRB6BKrKR+Bz5Lxkcf5fCEl+DCBldnqe30wvuOLnjQs23hKC", - "paymentMethodType" : "giropay", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttuozAQ-ZrwFmQu4fLAQ5aSLdt0t2KhTftSuWYK3iY2tQ0t*fod2DSqqpWssXXOaOacGT8pKupU1pA0XMmOjhbrlQLBxhnMqsI6gGItFWbNmOyFSUrQ5vqEnclcGGgUNVwK24wdJOllll79qsrH79nPrMjT-2YOoDTeiR*f6QKeYeoPiTaKi*YTYXolLqihSRw7gRNG8YpEcUiCzTnnN28SSm82Ls8DXzZ35raA-J6*FX9Yebfb5UX37XhP04cgruTxiiy8CwstHwDNHWZvDiHEUqCrYpu0xnQLb71wN3j2ktF9K7VBJCIRQYi1wF5kb3Qruw4UIhrUwBlofN78K5sLJg-oooCaK2AGmcH5KHfKuQbTynrhbb4MGtV9HvXCDdQ8AtSG1KQOG60mgatJIoZR9mqJDTsqRhvvGbRt29Kgpznf0j2vuRkTl7jOkvhLEpVOgI6cCAOJH6yTl2lHirJpR0mGhSZlYOkXLuZf0fVP9uDapzWEQRiGTuT59jEfdl75I6ijYczcdv3*yOq2fa9IXh2f-dfta3a5zRoY61r*BdOr2bA", - "method" : "GET", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgB0GGL0YONwvtT7avYeWcADNdByJj4DWcbKRhIcKNkM6pNv/qTpAj2bVRJpBnbMGC7PW0bf7GHgiFlCIBEoLbokvwkjZkjFpYjhRgdAd3/Tu3ARSXC10Z93sXC8ARJNoS9nAYiJ0sN2A+YUb5Re3H3PAf+JUww2RTw8j5ewpZS7R7SoOdWLRB6wADekDKpF1pEn/wZ1iggdVDUbC6yJu/kMI8rHSpXMXGt3mJwICndP5pj2ZTZ4oZKQuW8inIWioHEChnoBluVh8vR5v4O5m7x1qHUI+KMKmg46XCRz4HSeyZSSt0i/YEtmAc2CvJBOLnfNBWjEU9Q9wz7XUaqhdyJSLhxfiGmNqMXlOR5CP3hIWoWzaSxjBGxj7EHyEYH+APgTb6DSTwFcwdUrRKNiJbXT7TcxvYp2oWy6+8euOEyvQmBGStilH8HlZ/evPw1ETL/gH9vb0cltE9g8BXtT/zVftwgElIB8OUSHqSajwbr1ixz+84ceFB6qxWkMKaoA8exrOv4xW8HkAbD62HQWkORY3CWW6+Azn/1jM60VRAUjFxhOJrPGRjR6huaJuh8+B9+KhofihfpwTPQKA0DniZmkL52NFqPW6wHI3siWycd6bgl6NiMUm1Ay1hnMGddfFg7/mijYOAGxHloCrxGa61VdLJRDxnTfKDUzWXqv39hMwxCg7iZZe7JoYWSfeJdjfo+PAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifeBfB4hwExhN4+D+GEuR+ULSZhV5dUQ+HOIC/Bzwak/E1AhOZr5O+F4SyYt4NMhvm89xpP3yiFEYDyAE3kLjBonTZupkZkgmWmOmm1/C+ta8/tykMBVAusTSQ+1GeSmPvO7L4a9AtWek8OjEx4TLd4779HQpTGIWCqY19x4dh4OJM6vTqB57yS1fHvp/Y8RHwgrRUzuqCmZ+ERPBG0+3kqy0XeA0mwKf6MMy8yEwlYOAio/9qO3+XNofeQc8TuK/5vuGxd74nf29o9vugQWNShqKt/ITfmQp+uO/kSynDJnE/RVRLf2MldQfEVxQd9WKGX0bCkJP8GKPo7nWfzwBQ6+OqxdRT00N/tvi6ondb8RRH28RPktJGDfQ7GH5D6H7V4yXWhQWp6CXRF8mPaWwQV3lZje5WYRk4kgmGDKTja2ohNR1YFroQbg/TA8k67TIXqFqYyGdH5l5eGWKVPDJawHuQl0ctVwDAL5TCieqE0IcOHxEuYTsZt3oqw2PetNxZB2QtSHiB1az2jydwh5xv5KAhi3sOW9XdvS8JbgJuzRQpS50PEc+o2S79pv6q+XrTYma9DWNNg14wwhCTxZJQ9vAgZ/1wQwosMf957SKq7qaL5y0Auhan+HX3IbQ1qcyIUP/fiR1qAthLqvOu8xPikV/E7Twr+e7OBGeAFNZouJEuEr4DXLLOey6QuOBeTNaIk/sGur51RMDZ0FptsKGY3HzkatxcPmGBFxmcdPYjoxA4kiMcUBywdXnxRB6BKrKR+Bz5Lxkcf5fCEl+DCBldnqe30wvuOLnjQs23hKC", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUttuozAQ-ZrwFmQu4fLAQ5aSLdt0t2KhTftSuWYK3iY2tQ0t*fod2DSqqpWssXXOaOacGT8pKupU1pA0XMmOjhbrlQLBxhnMqsI6gGItFWbNmOyFSUrQ5vqEnclcGGgUNVwK24wdJOllll79qsrH79nPrMjT-2YOoDTeiR*f6QKeYeoPiTaKi*YTYXolLqihSRw7gRNG8YpEcUiCzTnnN28SSm82Ls8DXzZ35raA-J6*FX9Yebfb5UX37XhP04cgruTxiiy8CwstHwDNHWZvDiHEUqCrYpu0xnQLb71wN3j2ktF9K7VBJCIRQYi1wF5kb3Qruw4UIhrUwBlofN78K5sLJg-oooCaK2AGmcH5KHfKuQbTynrhbb4MGtV9HvXCDdQ8AtSG1KQOG60mgatJIoZR9mqJDTsqRhvvGbRt29Kgpznf0j2vuRkTl7jOkvhLEpVOgI6cCAOJH6yTl2lHirJpR0mGhSZlYOkXLuZf0fVP9uDapzWEQRiGTuT59jEfdl75I6ijYczcdv3*yOq2fa9IXh2f-dfta3a5zRoY61r*BdOr2bA" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15081,30 +11330,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "value" : { - "resultCode" : "RedirectShopper", - "action" : { - "paymentData" : "Ab02b4c0!BQABAgBK6QhIJjlNqvAPkOnf1HzcblwXCFm8j17/geaZbQWzWPhxHlvOzQw0TOdwxonkCYOHQDGEupixy+jiPAkPwjk9aubdkxkPMvtXNZC/4FaQSoRNRxXP/zLjD1ut7pQrYXtMhORqUpfy6BEYo3tz6JwUDeEvfPngMsJxKlKETkxU+VFvwPW6VsH70LVBaEnxqdhlKg02jqq3ROhksyTbwCN6VzipUfn0RJWizDxuLINEXgI2zr0WAmE+QXkcVx30FLq7ebgq6vO5JegU+eyow0M6teWIWdeeCpfPEH0uEY0Ijpv7M0DQiQlv4cPTPEH/xPgn3ha+i63acomRTtG+J+bZgKZqJIWONrZFCX8zUrtnO2zCQpYJE7aTewjACA7h7yU1ANNzp858v4zwktyUBfx/AWSRckgieZp/8N9FWmjVM902bPBrGUXKRXyjH4H2b9OFZivNmxl97iDIe/gXkfy54qy7m6MmztDgurQ44k9+e3wH+V2cnktBQnPPyGIn1w7Wi5GxZ8gP3fl7nDVMZkXaVH3X/Evl+8U+5vg+vORZqfINT3c3Gi2V53bNM1WenMrYXhmHfszODBTAqh1zyoZtmc+8CK/UaSmtOE/FOaxNmpG+i9ZUVQjxFWhQOpvhhsQuevtDJrilT/2beCcYXnqFoYmaKNP+yUrEM0PFzFpRGxDpLiBPDU8aTIHXkZu1MH4DAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSNlJboJoK1IzC49XNvAhpuEw3D/8HFQPenVjLW55FXRkA7hLhNAe6cK7luiuct7aryHgPUf+/sisCwXfndfPrFo6EVv6mDyBVbv1FQOpCAFIHawR9LoOar+mg3YuU2trdMX8awt2fWD5jSW0iIv4MEnQfFY9JRW5uP1a0jIvY/Bqcp6ejjs+Ic1ody7M/cqPrRgwVxPd9Mrm2OaMyZYrmtiIKWLzUiJWZ58zw8UuQ0c1PpY8+NLEd0dtIw7TR2K5YfmNSg4ZQcKyA11yUghsbpIG5+HZ8DoY2LNO36FJwRacScsx0Ipv54J3uzcK9Gp4gTUtzpzTVuUa+RGcCLVYrs5zIudmBMqzzKnDHPnmkCnLkjK0qkZzz/bPK7zwiaHtZdyGK/Kdrzekz4NgDArJ/VKl8ZnhRANjrKSiTgHo2JqNNF18pYisdVyj94KzWsneJvGtSKKEaIMokjZHiw6XlNGoF+TFExpEb+IauUa4fJBljpVRLRQlHlWAcqrwYBr4/E28oPobq+9AFCGC9zN8jKrqb7gBEDgfHAMWqj77JcIa62GrKg38ns+nkUhaP1wHz1xI7sFwVWp9HqBFhoaeSfImL9ofkYdcHUIyiu6o6/O6RqycWToDy3lFtXqok9NCdqjrtNmm2bhnMJ1UhDsG/1chxGC2SBAJERBX8O81hR3BdOwEWHUiPOn+PuyEnUImkOaVVIuKrHfjkAl70TVm1MPRHMy//ubL6dHWrET4BqxAEmdoSORpfIo9N4Q7Kktr0YS5g44hyjLhX+j6c8POPnc+mqVdeHxKA==", - "paymentMethodType" : "ideal", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUsFuozAQ-Rq4BdmQADn4kFC6YUu7URaiai*VY0*Dt4lNbUNLv34Nm22raiVrxnrPmnlvxgdNJc8UByI40JPPOq1BsmGC8nrnC2M60AUnGIfYP4NmDZV2xZjqpCUVGHt7wd7JQlo4amqFkoEdWiDZJs9uftTVw7f8Lt8V2X9f9qCNy2S*fKd38AijGiDGaiGPnwjbaXlFLSXLJY5xki4XaBknKP2o-VMcySLbo7mpSrTfrl-u48XmpajMoazv1qI5eeE6izZl-Du7CbeyKrzoym-pcAZn7zy5wwghX4OpdyVprG29aOWF1*6cFKOnRhnrkBSlyEGsAfakOmsa1bagHWJA94KBcdft37KFZOrsfOyACw3MOqbH-8pd3tyCbRT3ousvo3bqPg-bC2M9DcFpc9SozjVajAIXo0QXBtXpmWvYUjkELk9gEAS*ATNOek9Pggs7kBCFeIbmM5RWOHaOcDqG*Jd-8TJuSVM2bonkrtCoDHzzJOT0S9ruEPRhcFlEEidJgtNoHrwV-X1UfY952g952KxeHxhvmtcaFfXb4-y5fM43ZX6EgXP1B7Iy3CU", - "method" : "GET", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgBK6QhIJjlNqvAPkOnf1HzcblwXCFm8j17/geaZbQWzWPhxHlvOzQw0TOdwxonkCYOHQDGEupixy+jiPAkPwjk9aubdkxkPMvtXNZC/4FaQSoRNRxXP/zLjD1ut7pQrYXtMhORqUpfy6BEYo3tz6JwUDeEvfPngMsJxKlKETkxU+VFvwPW6VsH70LVBaEnxqdhlKg02jqq3ROhksyTbwCN6VzipUfn0RJWizDxuLINEXgI2zr0WAmE+QXkcVx30FLq7ebgq6vO5JegU+eyow0M6teWIWdeeCpfPEH0uEY0Ijpv7M0DQiQlv4cPTPEH/xPgn3ha+i63acomRTtG+J+bZgKZqJIWONrZFCX8zUrtnO2zCQpYJE7aTewjACA7h7yU1ANNzp858v4zwktyUBfx/AWSRckgieZp/8N9FWmjVM902bPBrGUXKRXyjH4H2b9OFZivNmxl97iDIe/gXkfy54qy7m6MmztDgurQ44k9+e3wH+V2cnktBQnPPyGIn1w7Wi5GxZ8gP3fl7nDVMZkXaVH3X/Evl+8U+5vg+vORZqfINT3c3Gi2V53bNM1WenMrYXhmHfszODBTAqh1zyoZtmc+8CK/UaSmtOE/FOaxNmpG+i9ZUVQjxFWhQOpvhhsQuevtDJrilT/2beCcYXnqFoYmaKNP+yUrEM0PFzFpRGxDpLiBPDU8aTIHXkZu1MH4DAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifSNlJboJoK1IzC49XNvAhpuEw3D/8HFQPenVjLW55FXRkA7hLhNAe6cK7luiuct7aryHgPUf+/sisCwXfndfPrFo6EVv6mDyBVbv1FQOpCAFIHawR9LoOar+mg3YuU2trdMX8awt2fWD5jSW0iIv4MEnQfFY9JRW5uP1a0jIvY/Bqcp6ejjs+Ic1ody7M/cqPrRgwVxPd9Mrm2OaMyZYrmtiIKWLzUiJWZ58zw8UuQ0c1PpY8+NLEd0dtIw7TR2K5YfmNSg4ZQcKyA11yUghsbpIG5+HZ8DoY2LNO36FJwRacScsx0Ipv54J3uzcK9Gp4gTUtzpzTVuUa+RGcCLVYrs5zIudmBMqzzKnDHPnmkCnLkjK0qkZzz/bPK7zwiaHtZdyGK/Kdrzekz4NgDArJ/VKl8ZnhRANjrKSiTgHo2JqNNF18pYisdVyj94KzWsneJvGtSKKEaIMokjZHiw6XlNGoF+TFExpEb+IauUa4fJBljpVRLRQlHlWAcqrwYBr4/E28oPobq+9AFCGC9zN8jKrqb7gBEDgfHAMWqj77JcIa62GrKg38ns+nkUhaP1wHz1xI7sFwVWp9HqBFhoaeSfImL9ofkYdcHUIyiu6o6/O6RqycWToDy3lFtXqok9NCdqjrtNmm2bhnMJ1UhDsG/1chxGC2SBAJERBX8O81hR3BdOwEWHUiPOn+PuyEnUImkOaVVIuKrHfjkAl70TVm1MPRHMy//ubL6dHWrET4BqxAEmdoSORpfIo9N4Q7Kktr0YS5g44hyjLhX+j6c8POPnc+mqVdeHxKA==", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUsFuozAQ-Rq4BdmQADn4kFC6YUu7URaiai*VY0*Dt4lNbUNLv34Nm22raiVrxnrPmnlvxgdNJc8UByI40JPPOq1BsmGC8nrnC2M60AUnGIfYP4NmDZV2xZjqpCUVGHt7wd7JQlo4amqFkoEdWiDZJs9uftTVw7f8Lt8V2X9f9qCNy2S*fKd38AijGiDGaiGPnwjbaXlFLSXLJY5xki4XaBknKP2o-VMcySLbo7mpSrTfrl-u48XmpajMoazv1qI5eeE6izZl-Du7CbeyKrzoym-pcAZn7zy5wwghX4OpdyVprG29aOWF1*6cFKOnRhnrkBSlyEGsAfakOmsa1bagHWJA94KBcdft37KFZOrsfOyACw3MOqbH-8pd3tyCbRT3ousvo3bqPg-bC2M9DcFpc9SozjVajAIXo0QXBtXpmWvYUjkELk9gEAS*ATNOek9Pggs7kBCFeIbmM5RWOHaOcDqG*Jd-8TJuSVM2bonkrtCoDHzzJOT0S9ruEPRhcFlEEidJgtNoHrwV-X1UfY952g952KxeHxhvmtcaFfXb4-y5fM43ZX6EgXP1B7Iy3CU" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15243,30 +11468,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "value" : { - "resultCode" : "RedirectShopper", - "action" : { - "paymentData" : "Ab02b4c0!BQABAgANyRgy/Cb83UcMZgH26iRoesCdEWFukqzzkhE+5ftULQ3vt3u/wz4HJSwjDdOGV/m0MPpgtK4gUjH7pI/2BjN6TsWyuVR4Q7lLkpzDXfcWPp2MzPnuL44TlLJcnDbeC0PjoFC61mX/z8/4+3FtgMRI6N5T8lmSq37FS0b5UjSLxGgHzRWVwXbxVDTfJFM15TWF/shBi5NQrEcprfSZTLUQ7XWk2p9HRTmS50Ga/GSq0xDwsPo02f14r7iNKDPBD4U7pMpgPxNVDsiVwiwPwUyTaPz4nnq/+UVdknsU1/fKiYXNYVD4hfDPlaknja0i6Au+HDh0CCLrgoNd/PUI2EGz8fiSjbLWDRAI5+9gf895urW6b8ckjzYTqVVKgc74e8T0yBJaTF9Kd1IYCTt0jZU/ijVwDK848AZurobAlPYiF7sQOXgFAXeQHmmXDSNXJwMH9OdleCzkUcvB/4i1ZIfFxblTmncX3FDBc0yc6FPVgmtfBWQLOpAZl8tNREG6RwRNnW5kLkjMSDXSfwmGdW7LNVF1SBv+uemTRK9+jmhg+qRyUR/XQht+eGosYQYlyut06izAuI4dhG+Ro9bn09WjQxVnaEvD6Uq65IU4LWv2HcjWjpKlBOv5ejNo4H8DnwybnRA5SdN/EY/iZod86yG3tTAbY4Ayvo2Q+lG7Vb7LcRAOlt9cfqtyXgaKymPax8NiAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd3J3r8hnE9gF0UJyMarOonSJWlwT+31JLeSYSOT5AmjUV9w7SwcjfsIF+LqjNHnC8lj1AnQVcXe4B8DoZ/SwIANLW/6BbMf9C3CgIrE3VpCZl7p8ljpp+8GSXHPULuf5mSk6wiwQficutG0Uspisuj5dCU9nbmBfHgnhNPEYone4d8efMIOvh8gKCaSG3vqlfLtKETuFDLWPoNMfv1ILw1uCSmNZd5xLMISjFtoz2bdQ+ds91tQGGUUvqsnhwqGyUpXP1T+sJWbESbgZCbANF1qaZTSJ7Iex5Myh9gRSvkW5376N6D7iYJQ3VlgHMWxgjmgf02EgOcqFanMcpr2kq4p4tpXMuK6EEXd3fvuGIMDwA1cD5CflbiKSwQ/PjGIvng5l1Ywi5py00oL0gbV716eog6xIYy+M3c5frNe56WCSxAakbsut66a9uVskqQXIDw/pTfE07/LRA3vOvXBTl8O3WCc3s3JGLJXgtvoaTRnuriIIOJ5m1d+5ATMIxU9tDgXOh4fzMRd7gxkPhBnIQJ9ERjTsoVgKJcicjA3dq7c60DbshZ0EWzSYwdENl3vhYnwkl60wo/6kgRvWGillBLb1nMtldst2J/z6WMbmPHqtvSOiJr5uMA0yisPOWVaod4HnThVyPeluTNOoLAnlqCHr+W/h0VhqPVWHi4dfCG/Tx2Y4Vi1OU0cP9TMjpfMj7zAsdTEoRRKQsIXy47YNhM3pCTNTuOrxoyf1i4WHO6v8+Q7DjVAOQUlpUnWY1hvbBz36Pn2T6yzDosWA+1J3rVLo8oj1kbjwzmwgYM7kQ0=", - "paymentMethodType" : "directEbanking", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUu9vmzAQ-WvgW5ANhB8f*JClZKFL1o3CVPVL5ZhrQAk2tQ0L*et3pFlaTZOss-Xe6e69O*8UE9VSVpBUjQJu0h0Th0bsbd4rBYKPFy4tc7sFxWsmzIJz2QuTFKDN9ordyEwY2CtmGikcM3aQLNfp8ttDWbx8Tb*nebb8b*YASuOd*PGNzuEVpv6QaKMmPR*E6ZW4Y4YlcUwDGkbxnJI4pPTLLeex2SfdhrfRY2ruu7XlruCMQZ2eMkbd7aoR8Owfi98H0g-kgMziwf9peXd2x8YW0GJ7cUgJIbYCXeabpDams7wF5uI5Ss6OtdQGkYhEBCFeAz-I3uhadh0oRDSooeGg8fnjvWwmuGzRSw7vs0ZmoH-LXXO2YGpZWd7qn3Gjus8Dt9xAXQaB2pCa1GGj*SRwPknEMMpezbBhx8To4H0BHcexNehp2r-YsakaMyYucemM*DMSFTRARzTC4MbP9tXLtCnF*LSpJMVCkzKwNf6Sy9-o*p0zuM51GWEQhiGNPN85Z8OTV9wHVTSMqVsvTi*8qutTSbLy-Oq-bd7S9Sbdw1hV8g8Atd1V", - "method" : "GET", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgANyRgy/Cb83UcMZgH26iRoesCdEWFukqzzkhE+5ftULQ3vt3u/wz4HJSwjDdOGV/m0MPpgtK4gUjH7pI/2BjN6TsWyuVR4Q7lLkpzDXfcWPp2MzPnuL44TlLJcnDbeC0PjoFC61mX/z8/4+3FtgMRI6N5T8lmSq37FS0b5UjSLxGgHzRWVwXbxVDTfJFM15TWF/shBi5NQrEcprfSZTLUQ7XWk2p9HRTmS50Ga/GSq0xDwsPo02f14r7iNKDPBD4U7pMpgPxNVDsiVwiwPwUyTaPz4nnq/+UVdknsU1/fKiYXNYVD4hfDPlaknja0i6Au+HDh0CCLrgoNd/PUI2EGz8fiSjbLWDRAI5+9gf895urW6b8ckjzYTqVVKgc74e8T0yBJaTF9Kd1IYCTt0jZU/ijVwDK848AZurobAlPYiF7sQOXgFAXeQHmmXDSNXJwMH9OdleCzkUcvB/4i1ZIfFxblTmncX3FDBc0yc6FPVgmtfBWQLOpAZl8tNREG6RwRNnW5kLkjMSDXSfwmGdW7LNVF1SBv+uemTRK9+jmhg+qRyUR/XQht+eGosYQYlyut06izAuI4dhG+Ro9bn09WjQxVnaEvD6Uq65IU4LWv2HcjWjpKlBOv5ejNo4H8DnwybnRA5SdN/EY/iZod86yG3tTAbY4Ayvo2Q+lG7Vb7LcRAOlt9cfqtyXgaKymPax8NiAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifd3J3r8hnE9gF0UJyMarOonSJWlwT+31JLeSYSOT5AmjUV9w7SwcjfsIF+LqjNHnC8lj1AnQVcXe4B8DoZ/SwIANLW/6BbMf9C3CgIrE3VpCZl7p8ljpp+8GSXHPULuf5mSk6wiwQficutG0Uspisuj5dCU9nbmBfHgnhNPEYone4d8efMIOvh8gKCaSG3vqlfLtKETuFDLWPoNMfv1ILw1uCSmNZd5xLMISjFtoz2bdQ+ds91tQGGUUvqsnhwqGyUpXP1T+sJWbESbgZCbANF1qaZTSJ7Iex5Myh9gRSvkW5376N6D7iYJQ3VlgHMWxgjmgf02EgOcqFanMcpr2kq4p4tpXMuK6EEXd3fvuGIMDwA1cD5CflbiKSwQ/PjGIvng5l1Ywi5py00oL0gbV716eog6xIYy+M3c5frNe56WCSxAakbsut66a9uVskqQXIDw/pTfE07/LRA3vOvXBTl8O3WCc3s3JGLJXgtvoaTRnuriIIOJ5m1d+5ATMIxU9tDgXOh4fzMRd7gxkPhBnIQJ9ERjTsoVgKJcicjA3dq7c60DbshZ0EWzSYwdENl3vhYnwkl60wo/6kgRvWGillBLb1nMtldst2J/z6WMbmPHqtvSOiJr5uMA0yisPOWVaod4HnThVyPeluTNOoLAnlqCHr+W/h0VhqPVWHi4dfCG/Tx2Y4Vi1OU0cP9TMjpfMj7zAsdTEoRRKQsIXy47YNhM3pCTNTuOrxoyf1i4WHO6v8+Q7DjVAOQUlpUnWY1hvbBz36Pn2T6yzDosWA+1J3rVLo8oj1kbjwzmwgYM7kQ0=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUu9vmzAQ-WvgW5ANhB8f*JClZKFL1o3CVPVL5ZhrQAk2tQ0L*et3pFlaTZOss-Xe6e69O*8UE9VSVpBUjQJu0h0Th0bsbd4rBYKPFy4tc7sFxWsmzIJz2QuTFKDN9ordyEwY2CtmGikcM3aQLNfp8ttDWbx8Tb*nebb8b*YASuOd*PGNzuEVpv6QaKMmPR*E6ZW4Y4YlcUwDGkbxnJI4pPTLLeex2SfdhrfRY2ruu7XlruCMQZ2eMkbd7aoR8Owfi98H0g-kgMziwf9peXd2x8YW0GJ7cUgJIbYCXeabpDams7wF5uI5Ss6OtdQGkYhEBCFeAz-I3uhadh0oRDSooeGg8fnjvWwmuGzRSw7vs0ZmoH-LXXO2YGpZWd7qn3Gjus8Dt9xAXQaB2pCa1GGj*SRwPknEMMpezbBhx8To4H0BHcexNehp2r-YsakaMyYucemM*DMSFTRARzTC4MbP9tXLtCnF*LSpJMVCkzKwNf6Sy9-o*p0zuM51GWEQhiGNPN85Z8OTV9wHVTSMqVsvTi*8qutTSbLy-Oq-bd7S9Sbdw1hV8g8Atd1V" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index 677c5cb..405fac9 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,35 +1603,35 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1617,8 +1650,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1632,8 +1665,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1647,8 +1680,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1662,8 +1695,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1682,8 +1715,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1698,6 +1731,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1761,8 +1797,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1776,8 +1812,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1791,8 +1827,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1806,8 +1842,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1826,8 +1862,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1842,6 +1878,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1896,8 +1935,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1911,8 +1950,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1926,8 +1965,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1941,8 +1980,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1961,8 +2000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1977,6 +2016,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2050,8 +2092,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2065,8 +2107,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2080,8 +2122,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2095,8 +2137,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2115,8 +2157,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2131,6 +2173,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2204,8 +2249,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2219,8 +2264,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2234,8 +2279,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2249,8 +2294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2269,8 +2314,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2285,6 +2330,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2358,8 +2406,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2373,8 +2421,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2388,8 +2436,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2403,8 +2451,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2423,8 +2471,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2439,6 +2487,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2512,8 +2563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2527,8 +2578,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2542,8 +2593,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2557,8 +2608,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2577,8 +2628,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2593,6 +2644,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2666,8 +2720,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2681,8 +2735,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2696,8 +2750,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2711,8 +2765,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2731,8 +2785,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2782,7 +2836,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2901,13 +2955,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3179,6 +3233,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3437,10 +3501,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3666,38 +3726,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3848,13 +3876,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3942,13 +3970,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4016,13 +4044,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4044,7 +4072,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4073,7 +4101,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4110,13 +4138,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4139,41 +4167,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4310,7 +4338,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4320,7 +4348,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4413,7 +4441,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4480,12 +4508,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4494,13 +4522,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4514,13 +4542,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4531,12 +4559,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4545,17 +4573,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4578,7 +4606,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4622,12 +4650,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4640,12 +4668,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4653,37 +4681,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -5264,7 +5292,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5411,7 +5439,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5425,7 +5453,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5565,7 +5593,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5635,7 +5663,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5720,7 +5748,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6032,13 +6060,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6061,13 +6089,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6098,13 +6126,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6131,13 +6159,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6270,13 +6298,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6365,16 +6393,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6638,13 +6656,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6672,13 +6690,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6709,7 +6727,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6719,7 +6737,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6757,13 +6775,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7045,7 +7063,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7093,7 +7111,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7112,7 +7130,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7148,7 +7166,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7175,7 +7193,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7231,7 +7249,7 @@ "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7304,7 +7322,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7325,7 +7343,7 @@ "PaymentMethod" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7464,7 +7482,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7476,7 +7494,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7501,7 +7519,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7510,8 +7528,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7545,7 +7563,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7602,7 +7620,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7665,12 +7683,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7679,7 +7697,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7694,12 +7712,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7708,7 +7726,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7722,34 +7740,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7763,13 +7781,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7780,7 +7798,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7789,17 +7807,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7819,7 +7837,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7961,7 +7979,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7971,12 +7989,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8016,12 +8034,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8034,12 +8052,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8047,35 +8065,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8091,7 +8109,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8166,7 +8184,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -8185,7 +8203,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8217,7 +8235,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8240,7 +8258,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8336,7 +8354,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8348,17 +8366,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8366,7 +8384,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8381,7 +8399,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8390,7 +8408,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8399,7 +8417,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8413,28 +8431,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8448,13 +8466,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8465,7 +8483,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8474,12 +8492,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8516,7 +8534,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8543,12 +8561,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8561,12 +8579,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8574,24 +8592,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8601,7 +8619,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8708,7 +8726,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8783,13 +8801,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8823,18 +8841,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8847,7 +8865,7 @@ "RecurringDetail" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8942,6 +8960,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9133,6 +9155,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9178,7 +9211,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9191,12 +9224,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9439,7 +9472,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9449,7 +9482,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9480,13 +9513,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9508,7 +9541,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9754,13 +9787,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9778,7 +9811,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9827,18 +9859,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9863,12 +9895,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -9908,7 +9940,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9929,7 +9961,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -9941,7 +9973,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -9957,7 +9989,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -9970,7 +10002,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -9991,7 +10023,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10033,7 +10065,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10042,7 +10074,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10076,7 +10108,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10086,7 +10118,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10114,13 +10146,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10213,13 +10245,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10266,16 +10298,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10284,35 +10307,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10335,23 +10330,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10363,20 +10341,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10387,13 +10351,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10404,16 +10361,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10445,18 +10392,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10480,2919 +10415,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14008,610 +11037,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14631,27 +11056,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14708,25 +11112,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14796,24 +11181,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "011026", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9V1BDJ" - }, - "pspReference" : "993617895160556C", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14838,24 +11205,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "040853", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9V28N0" - }, - "pspReference" : "993617895163558F", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14880,24 +11229,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "022851", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9USF5K" - }, - "pspReference" : "993617895139551B", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14918,44 +11249,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "042117", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UVQJ0" - }, - "pspReference" : "993617895155555B", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15057,27 +11351,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "051103", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9UUT9J" - }, - "pspReference" : "993617895152551D", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15093,30 +11366,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "value" : { - "resultCode" : "RedirectShopper", - "action" : { - "paymentData" : "Ab02b4c0!BQABAgCbCocr/c9RDB3l3GwHQ9ZghYfXrXmiHFU1DYCUvyD9+CzOhDaqzKmrU8In313x6Cn8UAB6HG2ndmAMVDoB7yWEVu9LDTMd2pmnolKLdUPbz8Ab9nYLs6Ne4VrkUIiErz4vw91CXOfK4UamqHjiec7Su/z9RwzvnLOK3nRJTO9tPu7hz2VzZzAXuzVOEmRNFScq8jVU7a4YnW6h9CniosKnFdZksMQ5bWPwf5ZjiOTsESt0KCgmIoptLEpWbVFERbpO42HmHhF5eZyYxX61VJJ/Wb/wxDnADFUAc8e2SrRWaM3Wrz3KOLe8tDP1w52xgY6cJjH1x7RpusscaZuyGj6MC7ymlS74wcEZ4MQLo0sxmCh3SSUnYGmRHcC3HH+FN7zfy631OSzyiJ1ZJ+bzVtpB6W3odoby2HkaSLxp3nbMYKf1QnxBEsckDg+0KIGa5PUiYma8vpLGtCACVi1F5bHgRFQM2AMRyqmhqrIGOHcdBgTnVkbzOpxjr6ywrFJNLvwr6k0Gpq2uymNohJ1Zl7mWs6hJMs+c54J5OflHsE24NPflw5aEXnkEcfOwotZnzcpXklNFVQ2Yp75z3DbvEw8M6u/OrKmLCFJp2d7O4vbtyMEOQkxGkbpeKa6jJAE6IVd+XjQwG/joTJkLT0LyRSjJoZPbikljkUa5WON6G85kZRD1DgwIWdPsm3DaSqRWTgSxAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWrq3BQxMlca+NqR0+uuqFcq12blP+pz9Al1HE3vMRiqm+HY60KEjKbrgypqNU3J0K0aOddQz5kA0mqTRGvaO00jFY9NOOgpPdgg+ZSHzMWi9MhQLNQGOvlC7UuzIF3QtemjEuXCMZKRhsOs5HAM50lOtbL3fQ7pqbSN1h3pI5kyP9hg220KE8wvz7HDm7fSy6+CTW3UTbwAQpT+LX5mEfXzMcvBanrbtSkTzDkE47KM4BAFLsjw72hPe9w4/9xwS5pH9CVoJdxmrc0QdZV+M6N3UJGt6ZX2wkGohRKHpcFWPjYk59CRfZsuDkwsIrok4UqPIjXSw1aZt5ABd6/L/XFMe1C+zdDW3IfxtIY0dwaHjg5WSpk2if0WpqH6XMrHW/0E/CdmWuMEnO1MSdla4GuSuad02Fm/Gr3XmTmiO6ycaHSAF6MOMHt1LuT7y7IKkG4dLfxwDMVese7EhVRzyooSFzO+ua3mb5M0phg6JpsJuNiqsrpqU7MEHBSiISTOuJvi0Kj6bZKaAMFvfQ7i28+CxM1J/MUKpaTcRheD5ZQFM/IDoprMdSQ3RgELZgJNrIO4bX2BXGhJ7muMCAivziPoIfvb6aOrs0j0n2KQfmtMu0gVIsEmzrkbhQAzpn4GuLWWtdQvyyb661hc1zeDit2xhxhlajJf+sjl3ByLr6YfFhrfuCuFbUs2YFIFU8A2OJQxMxwwfy/+fPRFbVxQ8w2Kt7n8by6rsRJO8Y17tV1bN4wKv7YjN5H96rdr9ZjfP2rKQ1FXz86rgYGb5sdlwiJZVU+Hihig/Z1mNJ7NsQ==", - "paymentMethodType" : "giropay", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmQgfOTBDykhDXfJNaKhivpSOfYGUINNbINKf30Nl4uq6iRrbc2sdmd2fZKEs0QwwGUtRUsGm3ZSAqfDBKZFbjcgaUW4XlIqOq7xAZTe3bA7mXENpSS6FtzRQws42aTJ76fi8PaY-knzLPlvZg9SmRsH6E7ncIaxP2ClZc3Lb4TuJF8RTfBi4YZuFC8C148i31vdc57rEj9t5z1p1vylPJ42u*TYlvu9116LV729Bo9n*qxZej4G-sryHoTlr2xjugFjr5ncuQghW4Iq8i2utG4tf2l5a3MugpJLJZQ2SIxiZCBaAX0XnVaVaFuQBlEg*5qCMs-937IZp6IxPnJgtQSqDdO7-8rdcnagK8Esf-1j1Ebd92FbXiinIRhthhrVmUbBKDAYJZowiE7OTMOW8MEx9wQ6jmMrUOOkX8ilZrUesIc8d4bmMxQf3NA4cmMTgujVvnkZtyQJHbeEU1NoVAa2eq-59C-a7uT0nnNbRBRGUeTG-tz5zPqjf-gVsrgfUq9afrxRVlUfBcqKz-P8ur2mm21awsCY*AIZ*9oT", - "method" : "GET", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgCbCocr/c9RDB3l3GwHQ9ZghYfXrXmiHFU1DYCUvyD9+CzOhDaqzKmrU8In313x6Cn8UAB6HG2ndmAMVDoB7yWEVu9LDTMd2pmnolKLdUPbz8Ab9nYLs6Ne4VrkUIiErz4vw91CXOfK4UamqHjiec7Su/z9RwzvnLOK3nRJTO9tPu7hz2VzZzAXuzVOEmRNFScq8jVU7a4YnW6h9CniosKnFdZksMQ5bWPwf5ZjiOTsESt0KCgmIoptLEpWbVFERbpO42HmHhF5eZyYxX61VJJ/Wb/wxDnADFUAc8e2SrRWaM3Wrz3KOLe8tDP1w52xgY6cJjH1x7RpusscaZuyGj6MC7ymlS74wcEZ4MQLo0sxmCh3SSUnYGmRHcC3HH+FN7zfy631OSzyiJ1ZJ+bzVtpB6W3odoby2HkaSLxp3nbMYKf1QnxBEsckDg+0KIGa5PUiYma8vpLGtCACVi1F5bHgRFQM2AMRyqmhqrIGOHcdBgTnVkbzOpxjr6ywrFJNLvwr6k0Gpq2uymNohJ1Zl7mWs6hJMs+c54J5OflHsE24NPflw5aEXnkEcfOwotZnzcpXklNFVQ2Yp75z3DbvEw8M6u/OrKmLCFJp2d7O4vbtyMEOQkxGkbpeKa6jJAE6IVd+XjQwG/joTJkLT0LyRSjJoZPbikljkUa5WON6G85kZRD1DgwIWdPsm3DaSqRWTgSxAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifWrq3BQxMlca+NqR0+uuqFcq12blP+pz9Al1HE3vMRiqm+HY60KEjKbrgypqNU3J0K0aOddQz5kA0mqTRGvaO00jFY9NOOgpPdgg+ZSHzMWi9MhQLNQGOvlC7UuzIF3QtemjEuXCMZKRhsOs5HAM50lOtbL3fQ7pqbSN1h3pI5kyP9hg220KE8wvz7HDm7fSy6+CTW3UTbwAQpT+LX5mEfXzMcvBanrbtSkTzDkE47KM4BAFLsjw72hPe9w4/9xwS5pH9CVoJdxmrc0QdZV+M6N3UJGt6ZX2wkGohRKHpcFWPjYk59CRfZsuDkwsIrok4UqPIjXSw1aZt5ABd6/L/XFMe1C+zdDW3IfxtIY0dwaHjg5WSpk2if0WpqH6XMrHW/0E/CdmWuMEnO1MSdla4GuSuad02Fm/Gr3XmTmiO6ycaHSAF6MOMHt1LuT7y7IKkG4dLfxwDMVese7EhVRzyooSFzO+ua3mb5M0phg6JpsJuNiqsrpqU7MEHBSiISTOuJvi0Kj6bZKaAMFvfQ7i28+CxM1J/MUKpaTcRheD5ZQFM/IDoprMdSQ3RgELZgJNrIO4bX2BXGhJ7muMCAivziPoIfvb6aOrs0j0n2KQfmtMu0gVIsEmzrkbhQAzpn4GuLWWtdQvyyb661hc1zeDit2xhxhlajJf+sjl3ByLr6YfFhrfuCuFbUs2YFIFU8A2OJQxMxwwfy/+fPRFbVxQ8w2Kt7n8by6rsRJO8Y17tV1bN4wKv7YjN5H96rdr9ZjfP2rKQ1FXz86rgYGb5sdlwiJZVU+Hihig/Z1mNJ7NsQ==", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFmQgfOTBDykhDXfJNaKhivpSOfYGUINNbINKf30Nl4uq6iRrbc2sdmd2fZKEs0QwwGUtRUsGm3ZSAqfDBKZFbjcgaUW4XlIqOq7xAZTe3bA7mXENpSS6FtzRQws42aTJ76fi8PaY-knzLPlvZg9SmRsH6E7ncIaxP2ClZc3Lb4TuJF8RTfBi4YZuFC8C148i31vdc57rEj9t5z1p1vylPJ42u*TYlvu9116LV729Bo9n*qxZej4G-sryHoTlr2xjugFjr5ncuQghW4Iq8i2utG4tf2l5a3MugpJLJZQ2SIxiZCBaAX0XnVaVaFuQBlEg*5qCMs-937IZp6IxPnJgtQSqDdO7-8rdcnagK8Esf-1j1Ebd92FbXiinIRhthhrVmUbBKDAYJZowiE7OTMOW8MEx9wQ6jmMrUOOkX8ilZrUesIc8d4bmMxQf3NA4cmMTgujVvnkZtyQJHbeEU1NoVAa2eq-59C-a7uT0nnNbRBRGUeTG-tz5zPqjf-gVsrgfUq9afrxRVlUfBcqKz-P8ur2mm21awsCY*AIZ*9oT" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15149,30 +11398,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "value" : { - "resultCode" : "RedirectShopper", - "action" : { - "paymentData" : "Ab02b4c0!BQABAgAgejLrmL/1NDgt5UM/kotd4pBlzIhQUUCnCx5fErtiyUQRIlz9Cxtt0craQ9k7KXqofIKsziPtvdX+spifXXOP1Xve6ycq9s1x5kH9kLLMcoFl34XCAeRKd64rrPA+1XJpRdM8BKzhy7lpx7NzOParV0h3ZfEJ00XzgSJjd5K6aedZSUGJSQQ97NSFfRQgthSQp3Y/qI8t40tDoOkVuL1/bhbJsAYqyWNTsfgtYS/RPO7351b5iDAwtUysUvIkWHGhhX9Jq2AwlcZMsXA27zjG2CVewSKap96OBU2kzRsOVO1ZDTQXYG2S/thUwKfl/K7N2CcxiDq9aN7euNzIGf1uupwzUfe33u544555l0MbfTAjR979fjXBm/C9zxg3spMdQovWrgCSUvQbMOIg/Xn4swBA4bSI3XtlRzB/DQfgwcbUEStf2c0dP0hPTTkYD50bT1kMdLHf/2csG7WlCJJn29DhUlhcoYDfgMkXyLng+Ae0bh+QGSxECMDnnPNLtpwWkxZwux4v5tRXLEiyRcUmDGHtBohBFsbTv9lU7BXaTW+fmFM35R7Afb7aUgGkxMbM9ZcDua2Lwg8WgHVx+bkK2lcQa3OGAEtYgEMC463GWsGO+x2CKzZ86yuNJTVypm9tCLwkVef55j2RWsbLjU7A6dEYf6HQFMUgl1vmFCnqZxCr/Lhb5Sy5CqQliBEcHCguAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUb1EXocZXF+ooYwdH65WLMWSoxifyCpyba1GNrz+on79V6FSg8rCV/n2h8AWsX/93aQilNkCHomaIkYHqXbl86yJokDAYutjLB9ay5Lw7IAqUdCntYbB08d1AnA6LE5/WQ+mbSslr/BcBDYybHw4dXXV00qZv4FBrfoi5seZyq4WQHzTb62KVELKRPgAFdSFOjRKXYt784MNPTM2pFWfDHXUseMFx6Ipr+bIH+KVxfxOza75T8e2jzwYFzKOQwX3MefJbjzudbC99AGWj1uBRnD9KcxttL8QqAA3OI52qmo8kj49fGqK+PPNcRwYM+ziFEG9woBOiwKOilubtTDbttZoVtFBh2JCWJGpKPWOtZ0Xu5C7/nJV9fKT0VGM1HdfOgMOC/OuOzv9M8oTzF17KhxB7YXbZ9Wwlh98E3tmJk/LABE73ccVCs1CJZYq3NgMshqoxcfvfubrOPLHlEthSSvK7X/w10m4HCBwyqLDQmDAoeJGNltHQHEQPLq8PuhYkOZ8SGEEMCyKTGBjAvLAYl0B9lWA6djhHTtI/5zia/kZODivv7z0BtjeUBBs2KpEvEs7WbjhIN4okqp5aleI7Y6zTAUUueJ/mP81GVdlmr27PUahOH2aMXO6s0m8ffT3X98B+M/HEpIk3eVZmRoIEirv3CZ7+lfG65sJe8ukjxlC574a+QIu/rrXECOUj+dSKyD+z1vAXVtAoORDy1TkrK6bWDV7iEEe/qlhg3Ih1YBqoDnUcKlbVME0lVj7VX5OHtw5CN65bUrYBdkF88ycc3Rsblsf7CMSuA=", - "paymentMethodType" : "ideal", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUttuozAQ-ZrwFmRDuOTBDyihDd20u6JhL32pHHsCVhOb2oaGfP0aNhtVq5WssXXOaOacGe81lXylOBDBgR491mkNkg0TlFelJ4zpQBecYBxg7wSaNVTajDHVSUt2YOzjFbuRhbRQa2qFkr4dWiCrTb768rXavd7nT3lZrP6b2YM27iYRutElHGBUA8RYLWT9ibCdlmtqKVkucYyTdBnhKEzCxcMt51nU5FeGQXycTL7v03OWUl3*ODSXl-p*i9tN8oGf1rPgLkdWB0mgZuHaa*lwAmfvNLnDCCFPg6nKLWmsbWdh5vLdOSpGj40y1iEpSpGDWAPsTXXWNKptQTvEgO4FA*Oe3-6ULSRTJ*ejBC40MOuYHv8td815BNsoPgvv-hm1U-d52LMg1tMQnDZHjepco2gUGI0SXRhUp*euYUvl4Lt7An3f9wyYcdLf6VFwYQcSoADP0WKO0h2OnSO8HEP44l29jFvSlI1bIrkrNCoDz7wJOf2Sttv7feBfF5HESZLgNFz4l6L-Ge4eYp72Qx402fmV8aY5V6ioLofF*-Y932zzGgbO1W9o9N0x", - "method" : "GET", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgAgejLrmL/1NDgt5UM/kotd4pBlzIhQUUCnCx5fErtiyUQRIlz9Cxtt0craQ9k7KXqofIKsziPtvdX+spifXXOP1Xve6ycq9s1x5kH9kLLMcoFl34XCAeRKd64rrPA+1XJpRdM8BKzhy7lpx7NzOParV0h3ZfEJ00XzgSJjd5K6aedZSUGJSQQ97NSFfRQgthSQp3Y/qI8t40tDoOkVuL1/bhbJsAYqyWNTsfgtYS/RPO7351b5iDAwtUysUvIkWHGhhX9Jq2AwlcZMsXA27zjG2CVewSKap96OBU2kzRsOVO1ZDTQXYG2S/thUwKfl/K7N2CcxiDq9aN7euNzIGf1uupwzUfe33u544555l0MbfTAjR979fjXBm/C9zxg3spMdQovWrgCSUvQbMOIg/Xn4swBA4bSI3XtlRzB/DQfgwcbUEStf2c0dP0hPTTkYD50bT1kMdLHf/2csG7WlCJJn29DhUlhcoYDfgMkXyLng+Ae0bh+QGSxECMDnnPNLtpwWkxZwux4v5tRXLEiyRcUmDGHtBohBFsbTv9lU7BXaTW+fmFM35R7Afb7aUgGkxMbM9ZcDua2Lwg8WgHVx+bkK2lcQa3OGAEtYgEMC463GWsGO+x2CKzZ86yuNJTVypm9tCLwkVef55j2RWsbLjU7A6dEYf6HQFMUgl1vmFCnqZxCr/Lhb5Sy5CqQliBEcHCguAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifUb1EXocZXF+ooYwdH65WLMWSoxifyCpyba1GNrz+on79V6FSg8rCV/n2h8AWsX/93aQilNkCHomaIkYHqXbl86yJokDAYutjLB9ay5Lw7IAqUdCntYbB08d1AnA6LE5/WQ+mbSslr/BcBDYybHw4dXXV00qZv4FBrfoi5seZyq4WQHzTb62KVELKRPgAFdSFOjRKXYt784MNPTM2pFWfDHXUseMFx6Ipr+bIH+KVxfxOza75T8e2jzwYFzKOQwX3MefJbjzudbC99AGWj1uBRnD9KcxttL8QqAA3OI52qmo8kj49fGqK+PPNcRwYM+ziFEG9woBOiwKOilubtTDbttZoVtFBh2JCWJGpKPWOtZ0Xu5C7/nJV9fKT0VGM1HdfOgMOC/OuOzv9M8oTzF17KhxB7YXbZ9Wwlh98E3tmJk/LABE73ccVCs1CJZYq3NgMshqoxcfvfubrOPLHlEthSSvK7X/w10m4HCBwyqLDQmDAoeJGNltHQHEQPLq8PuhYkOZ8SGEEMCyKTGBjAvLAYl0B9lWA6djhHTtI/5zia/kZODivv7z0BtjeUBBs2KpEvEs7WbjhIN4okqp5aleI7Y6zTAUUueJ/mP81GVdlmr27PUahOH2aMXO6s0m8ffT3X98B+M/HEpIk3eVZmRoIEirv3CZ7+lfG65sJe8ukjxlC574a+QIu/rrXECOUj+dSKyD+z1vAXVtAoORDy1TkrK6bWDV7iEEe/qlhg3Ih1YBqoDnUcKlbVME0lVj7VX5OHtw5CN65bUrYBdkF88ycc3Rsblsf7CMSuA=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUttuozAQ-ZrwFmRDuOTBDyihDd20u6JhL32pHHsCVhOb2oaGfP0aNhtVq5WssXXOaOacGe81lXylOBDBgR491mkNkg0TlFelJ4zpQBecYBxg7wSaNVTajDHVSUt2YOzjFbuRhbRQa2qFkr4dWiCrTb768rXavd7nT3lZrP6b2YM27iYRutElHGBUA8RYLWT9ibCdlmtqKVkucYyTdBnhKEzCxcMt51nU5FeGQXycTL7v03OWUl3*ODSXl-p*i9tN8oGf1rPgLkdWB0mgZuHaa*lwAmfvNLnDCCFPg6nKLWmsbWdh5vLdOSpGj40y1iEpSpGDWAPsTXXWNKptQTvEgO4FA*Oe3-6ULSRTJ*ejBC40MOuYHv8td815BNsoPgvv-hm1U-d52LMg1tMQnDZHjepco2gUGI0SXRhUp*euYUvl4Lt7An3f9wyYcdLf6VFwYQcSoADP0WKO0h2OnSO8HEP44l29jFvSlI1bIrkrNCoDz7wJOf2Sttv7feBfF5HESZLgNFz4l6L-Ge4eYp72Qx402fmV8aY5V6ioLofF*-Y932zzGgbO1W9o9N0x" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15313,30 +11538,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "value" : { - "resultCode" : "RedirectShopper", - "action" : { - "paymentData" : "Ab02b4c0!BQABAgB0+dPV+fRwAnBXX+A2fGzbbXVRuCdq7CQ2x0107iwt/hUloD+MgxZ8BEmOHmKpXNkPDSl6YuZKSxT+tpQszNY4HL2ooTPGHjHHpGNS9+No4+z70mFkvdV2u9G7mJx16dWSSBOCvY2bvBVVrLTnxv7HNEl4ciqdivSmpLE5Y3IqlXHqMv7eibbmhUe7OWSE/Kl7vSb5iq49u21ip7Xj6s+uhi28zrrhDClCYooIewYBPBWFYOgs6Wqx5LkjDkxdig9UAiQYTKtm+IjTxkonidPrvOlo/oDWISUsCU2Kv4LlyaIQDIVPTJkEnJVvP6RjikNs0f5i+I21DTv7q70A5IEoQvayTyg2eEhJBZXmCA+e/kUXK9VSjSKbX0zZ9Go1H3xpWmd1xj6VLgwA34NwqHNzW63nmndTp90i+UcFj4ZPgHkV+p59XgNYHCWFjD+qtv1CwumniUBwQYbgAhwGC/nn0Y7uPAUVE4fH3sJQiV0I40K8UHwusxXTC6wP6E2qwrNTEm3Mf4eOqsmb2eUd81GFHPQsEasuh7mvm17jKRrfBuQmZ0h91iQBioMwkaKvg7n8nQk+lGWrnEQoH4tjqedLxPngjeBCLEj0uKGYyYeYEf0GcVI+jOPt3wR8ejqxvUJ47A0eny7aW5jgQCyBxkxR9ZgihQDKlWO0axPX+KLYKxAU+qeI98YXz36/BUIxgKtRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaFmjTYWP/sjHxcxXylNifxOVm6oe9j8aPFuUzrkec+MxKOPix4gHG0s00F+secwtzas3aCRLH62FpTHhwQhfeSp40paazBADS9cMbgDVk2gsgmNSS1dFWO+iWqlB3mX52mS1wOFnWkOxwkWUskqKygIigxyQsxQ8oggvccTUUbeRVSV3K+NqBz+Pru3xCoEvoAxBjDOEqGoPHA/umMU2ue3CVCu5TMOV831hj97mzKSxHtzf/KAs5LGr54AHFZxOuukTx4mVHr69F8MNNqCaCTTBYg1ZZdBCxsIejZvWHkzez6/qghPzoByZcLpUJ8REc5xQvZ0AXSQ2dwrKg9d4VmCAmqxj3lkErpjoYSp5CT4QCVDUm32JvVTCAeCm5msz9f7rVJrUZElRdt0iWsX4YeqU/SPt0BMnzLfTQgXeaT29cuHRnMVJE/ky69LdiMbbEWPWY3W9Ygw606RvXu2GSADJa0vDm+nfDdRjlA7jZxddiATjrvbPCQVdLVddwi6xEA5Of0JIh+ZD7RAfp39kGILHNLnjcxWSprZa5rZulZX6yiBvRYgAb6zB6bEa+i/gWvLEYka8GgBl+NLnZC+hcpEJ0gP5a5bjEmMpd1IrgDSHF0SzXbLLOZKVy5JBy/9IZr3cNcEF31tU4+RudvAVaWAkZmer18O+DVh+Ctu6NLzCS0OvGpt40UMAPRQoQor/UldSKl5KU0nhG+7usZnJPuKwVlXmlYpTdv5kUYxfsnJ0ArplK4N47pB9UFhMY23gTPzd8MECtoCbEnxCIkHOTgEwup7JnphbT6b3W7XV30=", - "paymentMethodType" : "directEbanking", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUlGPojAQ-jXwJimggA99cBGF1fUMpxv3Xja1jEBWW2wLkf3127Ked7lcQjpkvunM933ToyCsiHkBuKgFUJUcCfuoWWnTVghgtB*wZJ-bFxC0IkzNKOUtU3gHUr3ccw8wYwpKQVTNmaP6BnCcJvHqx373vkw2SZ7F-63sQEgd8QQ94BxOYOYDlkoYPn8A1Qo2J4rg6dQN3DCaTkzwo9Wj5mdd4qrvxqmvlrdtdHgt8*vT83KTHixvId-ylMHq7bQpW7mYW95TvJ1Jy5-bDekvoAVeBn0uQsgWIPf5GldKNZY-07f1d*aUnCsulc5EKEI6RSugH7xVsuJNA8JMAdHVFKT*3X63zRjlF60kh2*nNdK5v9vda15AVbyw-MU-Zmt2f9tteYEYbNDcNGTY6UETQ3BiKOqj560Y6YENYb2j45B0HMeWII3Xr*RcF7XqsYc8d4TGIxTt3EArcqf68Nxf9l2L2ZMg1OwJJ7qRYQa21G9keBlNe3Q6z7mvIgzCMHQjf*x8Zt3B3z0HRdT1iVfNbu*0qKrbHmX7z9P4ur4m6TopoS8K-gXEVtz2", - "method" : "GET", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "paymentData" : "Ab02b4c0!BQABAgB0+dPV+fRwAnBXX+A2fGzbbXVRuCdq7CQ2x0107iwt/hUloD+MgxZ8BEmOHmKpXNkPDSl6YuZKSxT+tpQszNY4HL2ooTPGHjHHpGNS9+No4+z70mFkvdV2u9G7mJx16dWSSBOCvY2bvBVVrLTnxv7HNEl4ciqdivSmpLE5Y3IqlXHqMv7eibbmhUe7OWSE/Kl7vSb5iq49u21ip7Xj6s+uhi28zrrhDClCYooIewYBPBWFYOgs6Wqx5LkjDkxdig9UAiQYTKtm+IjTxkonidPrvOlo/oDWISUsCU2Kv4LlyaIQDIVPTJkEnJVvP6RjikNs0f5i+I21DTv7q70A5IEoQvayTyg2eEhJBZXmCA+e/kUXK9VSjSKbX0zZ9Go1H3xpWmd1xj6VLgwA34NwqHNzW63nmndTp90i+UcFj4ZPgHkV+p59XgNYHCWFjD+qtv1CwumniUBwQYbgAhwGC/nn0Y7uPAUVE4fH3sJQiV0I40K8UHwusxXTC6wP6E2qwrNTEm3Mf4eOqsmb2eUd81GFHPQsEasuh7mvm17jKRrfBuQmZ0h91iQBioMwkaKvg7n8nQk+lGWrnEQoH4tjqedLxPngjeBCLEj0uKGYyYeYEf0GcVI+jOPt3wR8ejqxvUJ47A0eny7aW5jgQCyBxkxR9ZgihQDKlWO0axPX+KLYKxAU+qeI98YXz36/BUIxgKtRAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifaFmjTYWP/sjHxcxXylNifxOVm6oe9j8aPFuUzrkec+MxKOPix4gHG0s00F+secwtzas3aCRLH62FpTHhwQhfeSp40paazBADS9cMbgDVk2gsgmNSS1dFWO+iWqlB3mX52mS1wOFnWkOxwkWUskqKygIigxyQsxQ8oggvccTUUbeRVSV3K+NqBz+Pru3xCoEvoAxBjDOEqGoPHA/umMU2ue3CVCu5TMOV831hj97mzKSxHtzf/KAs5LGr54AHFZxOuukTx4mVHr69F8MNNqCaCTTBYg1ZZdBCxsIejZvWHkzez6/qghPzoByZcLpUJ8REc5xQvZ0AXSQ2dwrKg9d4VmCAmqxj3lkErpjoYSp5CT4QCVDUm32JvVTCAeCm5msz9f7rVJrUZElRdt0iWsX4YeqU/SPt0BMnzLfTQgXeaT29cuHRnMVJE/ky69LdiMbbEWPWY3W9Ygw606RvXu2GSADJa0vDm+nfDdRjlA7jZxddiATjrvbPCQVdLVddwi6xEA5Of0JIh+ZD7RAfp39kGILHNLnjcxWSprZa5rZulZX6yiBvRYgAb6zB6bEa+i/gWvLEYka8GgBl+NLnZC+hcpEJ0gP5a5bjEmMpd1IrgDSHF0SzXbLLOZKVy5JBy/9IZr3cNcEF31tU4+RudvAVaWAkZmer18O+DVh+Ctu6NLzCS0OvGpt40UMAPRQoQor/UldSKl5KU0nhG+7usZnJPuKwVlXmlYpTdv5kUYxfsnJ0ArplK4N47pB9UFhMY23gTPzd8MECtoCbEnxCIkHOTgEwup7JnphbT6b3W7XV30=", - "redirect" : { - "method" : "GET", - "url" : "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUlGPojAQ-jXwJimggA99cBGF1fUMpxv3Xja1jEBWW2wLkf3127Ked7lcQjpkvunM933ToyCsiHkBuKgFUJUcCfuoWWnTVghgtB*wZJ-bFxC0IkzNKOUtU3gHUr3ccw8wYwpKQVTNmaP6BnCcJvHqx373vkw2SZ7F-63sQEgd8QQ94BxOYOYDlkoYPn8A1Qo2J4rg6dQN3DCaTkzwo9Wj5mdd4qrvxqmvlrdtdHgt8*vT83KTHixvId-ylMHq7bQpW7mYW95TvJ1Jy5-bDekvoAVeBn0uQsgWIPf5GldKNZY-07f1d*aUnCsulc5EKEI6RSugH7xVsuJNA8JMAdHVFKT*3X63zRjlF60kh2*nNdK5v9vda15AVbyw-MU-Zmt2f9tteYEYbNDcNGTY6UETQ3BiKOqj560Y6YENYb2j45B0HMeWII3Xr*RcF7XqsYc8d4TGIxTt3EArcqf68Nxf9l2L2ZMg1OwJJ7qRYQa21G9keBlNe3Q6z7mvIgzCMHQjf*x8Zt3B3z0HRdT1iVfNbu*0qKrbHmX7z9P4ur4m6TopoS8K-gXEVtz2" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15376,30 +11577,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index d36ddd2..839f226 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,38 +1603,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1620,8 +1653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1635,8 +1668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1650,8 +1683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1665,8 +1698,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1685,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1701,6 +1734,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1764,8 +1800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1779,8 +1815,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1794,8 +1830,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1845,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1829,8 +1865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1845,6 +1881,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1899,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1914,8 +1953,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1929,8 +1968,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1944,8 +1983,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1964,8 +2003,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1980,6 +2019,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2053,8 +2095,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2068,8 +2110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2083,8 +2125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2098,8 +2140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2118,8 +2160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2134,6 +2176,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2207,8 +2252,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2222,8 +2267,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2237,8 +2282,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2252,8 +2297,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2272,8 +2317,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2288,6 +2333,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2361,8 +2409,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2376,8 +2424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2391,8 +2439,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2406,8 +2454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2426,8 +2474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2442,6 +2490,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2515,8 +2566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2530,8 +2581,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2545,8 +2596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2560,8 +2611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2580,8 +2631,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2596,6 +2647,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2669,8 +2723,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2684,8 +2738,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2699,8 +2753,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2714,8 +2768,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2734,8 +2788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,7 +2839,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2904,13 +2958,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3182,6 +3236,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3440,10 +3504,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3669,38 +3729,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3851,13 +3879,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3945,13 +3973,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4019,13 +4047,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4047,7 +4075,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4076,7 +4104,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4113,13 +4141,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4142,41 +4170,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4313,7 +4341,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4323,7 +4351,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4416,7 +4444,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4483,12 +4511,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4497,13 +4525,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4517,19 +4545,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4540,12 +4568,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4554,17 +4582,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4587,7 +4615,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4631,12 +4659,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4649,12 +4677,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4662,37 +4690,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -5273,7 +5301,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5420,7 +5448,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5434,7 +5462,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5574,7 +5602,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5644,7 +5672,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5729,7 +5757,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6041,13 +6069,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6070,13 +6098,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6107,13 +6135,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6140,13 +6168,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6279,13 +6307,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6374,16 +6402,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6647,13 +6665,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6681,13 +6699,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6718,7 +6736,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6728,7 +6746,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6766,13 +6784,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7054,7 +7072,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7102,7 +7120,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7121,7 +7139,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7157,7 +7175,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7184,7 +7202,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7240,13 +7258,13 @@ "type" : "string" }, "id" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "description" : "A unique identifier of the payment link.", "readOnly" : true, "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7319,7 +7337,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7341,7 +7359,7 @@ "PaymentMethod" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7480,7 +7498,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7492,7 +7510,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7513,7 +7531,7 @@ "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -7523,7 +7541,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7532,8 +7550,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7567,7 +7585,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7624,7 +7642,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7687,12 +7705,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7701,7 +7719,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7716,12 +7734,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7730,7 +7748,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7744,40 +7762,40 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7791,13 +7809,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7808,7 +7826,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7817,17 +7835,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7847,7 +7865,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7989,7 +8007,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7999,12 +8017,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8044,12 +8062,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8062,12 +8080,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8075,35 +8093,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8119,7 +8137,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8194,7 +8212,7 @@ "type" : "object" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -8213,7 +8231,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8245,7 +8263,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8268,7 +8286,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8364,7 +8382,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8376,17 +8394,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8394,7 +8412,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8409,7 +8427,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8418,7 +8436,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8427,7 +8445,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8441,34 +8459,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8482,13 +8500,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8499,7 +8517,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8508,12 +8526,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8550,7 +8568,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8577,12 +8595,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8595,12 +8613,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8608,24 +8626,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8635,7 +8653,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8742,7 +8760,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8817,13 +8835,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8857,18 +8875,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8881,7 +8899,7 @@ "RecurringDetail" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8976,6 +8994,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9167,6 +9189,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9212,7 +9245,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9225,12 +9258,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9473,7 +9506,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9483,7 +9516,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9514,13 +9547,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9542,7 +9575,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9788,13 +9821,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9812,7 +9845,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9861,18 +9893,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9897,12 +9929,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -9942,7 +9974,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9963,7 +9995,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -9975,7 +10007,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -9991,7 +10023,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -10004,7 +10036,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -10025,7 +10057,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10067,7 +10099,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10076,7 +10108,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10110,7 +10142,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10120,7 +10152,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10148,13 +10180,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10247,13 +10279,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10300,16 +10332,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10318,35 +10341,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10369,23 +10364,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10397,20 +10375,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10421,13 +10385,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10438,16 +10395,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10479,18 +10426,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10514,2919 +10449,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14042,610 +11071,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14665,27 +11090,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14742,25 +11146,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14830,24 +11215,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14872,24 +11239,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14914,24 +11263,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14952,44 +11283,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15045,29 +11339,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15112,27 +11383,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15148,30 +11398,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15204,30 +11430,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15368,30 +11570,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15431,30 +11609,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 2c39d02..c4a6ada 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,38 +1603,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1620,8 +1653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1635,8 +1668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1650,8 +1683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1665,8 +1698,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1685,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1701,6 +1734,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1764,8 +1800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1779,8 +1815,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1794,8 +1830,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1845,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1829,8 +1865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1845,6 +1881,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1899,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1914,8 +1953,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1929,8 +1968,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1944,8 +1983,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1964,8 +2003,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1980,6 +2019,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2053,8 +2095,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2068,8 +2110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2083,8 +2125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2098,8 +2140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2118,8 +2160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2134,6 +2176,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2207,8 +2252,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2222,8 +2267,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2237,8 +2282,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2252,8 +2297,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2272,8 +2317,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2288,6 +2333,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2361,8 +2409,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2376,8 +2424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2391,8 +2439,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2406,8 +2454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2426,8 +2474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2442,6 +2490,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2515,8 +2566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2530,8 +2581,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2545,8 +2596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2560,8 +2611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2580,8 +2631,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2596,6 +2647,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2669,8 +2723,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2684,8 +2738,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2699,8 +2753,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2714,8 +2768,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2734,8 +2788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,7 +2839,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2904,13 +2958,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3182,6 +3236,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3440,10 +3504,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3669,38 +3729,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3851,13 +3879,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3945,13 +3973,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4019,13 +4047,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4047,7 +4075,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4076,7 +4104,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4113,13 +4141,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4142,41 +4170,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4313,7 +4341,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4323,7 +4351,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4416,7 +4444,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4483,12 +4511,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4497,13 +4525,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4517,19 +4545,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4540,12 +4568,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4554,17 +4582,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4587,7 +4615,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4631,12 +4659,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4649,12 +4677,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4662,37 +4690,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -5273,7 +5301,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5420,7 +5448,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5434,7 +5462,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5574,7 +5602,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5644,7 +5672,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5729,7 +5757,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6041,13 +6069,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6070,13 +6098,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6107,13 +6135,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6140,13 +6168,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6279,13 +6307,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6374,16 +6402,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6647,13 +6665,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6681,13 +6699,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6718,7 +6736,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6728,7 +6746,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6766,13 +6784,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7054,7 +7072,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7102,12 +7120,12 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7126,7 +7144,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7162,7 +7180,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7189,7 +7207,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7245,13 +7263,13 @@ "type" : "string" }, "id" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "description" : "A unique identifier of the payment link.", "readOnly" : true, "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7324,7 +7342,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7346,7 +7364,7 @@ "PaymentMethod" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7485,7 +7503,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7497,7 +7515,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7518,7 +7536,7 @@ "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -7528,7 +7546,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7537,8 +7555,8 @@ "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7572,7 +7590,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7629,7 +7647,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7692,12 +7710,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7706,7 +7724,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7721,12 +7739,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7735,7 +7753,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7749,40 +7767,40 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7796,13 +7814,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7813,7 +7831,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7822,17 +7840,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7852,7 +7870,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7994,7 +8012,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8004,12 +8022,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8049,12 +8067,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8067,12 +8085,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8080,35 +8098,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8124,7 +8142,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8199,12 +8217,12 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -8223,7 +8241,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8255,7 +8273,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8278,7 +8296,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8374,7 +8392,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8386,17 +8404,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8404,7 +8422,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8419,7 +8437,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8428,7 +8446,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8437,7 +8455,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8451,34 +8469,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8492,13 +8510,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8509,7 +8527,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8518,12 +8536,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8560,7 +8578,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8587,12 +8605,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8605,12 +8623,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8618,24 +8636,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8645,7 +8663,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8752,7 +8770,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8827,13 +8845,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8867,18 +8885,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8891,7 +8909,7 @@ "RecurringDetail" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8986,6 +9004,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9177,6 +9199,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9222,7 +9255,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9235,12 +9268,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9483,7 +9516,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9493,7 +9526,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9524,13 +9557,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9552,7 +9585,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9798,13 +9831,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9822,7 +9855,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9871,18 +9903,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9907,12 +9939,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -9952,7 +9984,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9973,7 +10005,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -9985,7 +10017,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -10001,7 +10033,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -10014,7 +10046,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -10035,7 +10067,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10077,7 +10109,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10086,7 +10118,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10120,7 +10152,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10130,7 +10162,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10158,13 +10190,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10257,13 +10289,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10310,16 +10342,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10328,35 +10351,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10379,23 +10374,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10407,20 +10385,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10431,13 +10395,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10448,16 +10405,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10489,18 +10436,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10524,2919 +10459,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14052,610 +11081,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14675,27 +11100,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14752,25 +11156,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14840,24 +11225,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14882,24 +11249,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14924,24 +11273,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14962,44 +11293,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15055,29 +11349,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15122,27 +11393,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15158,30 +11408,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15214,30 +11440,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15378,30 +11580,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15441,30 +11619,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index ed85aba..de68392 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,38 +1603,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1620,8 +1653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1635,8 +1668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1650,8 +1683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1665,8 +1698,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1685,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1701,6 +1734,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1764,8 +1800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1779,8 +1815,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1794,8 +1830,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1845,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1829,8 +1865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1845,6 +1881,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1899,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1914,8 +1953,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1929,8 +1968,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1944,8 +1983,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1964,8 +2003,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1980,6 +2019,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2053,8 +2095,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2068,8 +2110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2083,8 +2125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2098,8 +2140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2118,8 +2160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2134,6 +2176,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2207,8 +2252,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2222,8 +2267,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2237,8 +2282,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2252,8 +2297,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2272,8 +2317,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2288,6 +2333,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2361,8 +2409,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2376,8 +2424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2391,8 +2439,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2406,8 +2454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2426,8 +2474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2442,6 +2490,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2515,8 +2566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2530,8 +2581,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2545,8 +2596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2560,8 +2611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2580,8 +2631,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2596,6 +2647,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2669,8 +2723,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2684,8 +2738,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2699,8 +2753,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2714,8 +2768,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2734,8 +2788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,7 +2839,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2904,13 +2958,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3182,6 +3236,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3440,10 +3504,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3669,38 +3729,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3851,13 +3879,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3945,13 +3973,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4019,13 +4047,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4047,7 +4075,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4076,7 +4104,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4113,13 +4141,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4142,41 +4170,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4313,7 +4341,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4323,7 +4351,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4416,7 +4444,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4483,12 +4511,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4497,13 +4525,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4517,19 +4545,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4540,12 +4568,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4554,17 +4582,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4587,7 +4615,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4631,12 +4659,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4649,12 +4677,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4662,37 +4690,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -5273,7 +5301,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5420,7 +5448,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5434,7 +5462,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5574,7 +5602,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5644,7 +5672,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5729,7 +5757,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6041,13 +6069,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6070,13 +6098,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6107,13 +6135,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6140,13 +6168,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6279,13 +6307,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6374,16 +6402,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6647,13 +6665,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6681,13 +6699,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6718,7 +6736,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6728,7 +6746,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6766,13 +6784,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7054,7 +7072,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7102,12 +7120,12 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -7126,7 +7144,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7162,7 +7180,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7189,7 +7207,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7245,13 +7263,13 @@ "type" : "string" }, "id" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "description" : "A unique identifier of the payment link.", "readOnly" : true, "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7324,7 +7342,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7346,7 +7364,7 @@ "PaymentMethod" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7368,7 +7386,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -7493,7 +7511,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7505,7 +7523,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7526,7 +7544,7 @@ "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -7536,7 +7554,7 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7545,14 +7563,14 @@ "type" : "string" }, "splitCardFundingSources" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "default" : false, "description" : "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", "type" : "boolean" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7586,7 +7604,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7643,7 +7661,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7706,12 +7724,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7720,7 +7738,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7735,12 +7753,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7749,7 +7767,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7763,40 +7781,40 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7810,13 +7828,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7827,7 +7845,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7836,17 +7854,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7866,7 +7884,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -8008,7 +8026,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8018,12 +8036,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8063,12 +8081,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8081,12 +8099,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8094,35 +8112,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8138,7 +8156,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8213,12 +8231,12 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "additionalProperties" : { "type" : "string" }, @@ -8237,7 +8255,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8269,7 +8287,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8292,7 +8310,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8388,7 +8406,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8400,17 +8418,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8418,7 +8436,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8433,7 +8451,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8442,7 +8460,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8451,7 +8469,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8465,34 +8483,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8506,13 +8524,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8523,7 +8541,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8532,12 +8550,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8574,7 +8592,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8601,12 +8619,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8619,12 +8637,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8632,24 +8650,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8659,7 +8677,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8766,7 +8784,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8841,13 +8859,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8881,18 +8899,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8905,7 +8923,7 @@ "RecurringDetail" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8927,7 +8945,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -9008,6 +9026,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9199,6 +9221,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9244,7 +9277,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9257,12 +9290,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9505,7 +9538,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9515,7 +9548,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9546,13 +9579,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9574,7 +9607,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9820,13 +9853,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9844,7 +9877,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9893,18 +9925,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9929,12 +9961,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -9974,7 +10006,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9995,7 +10027,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -10007,7 +10039,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -10023,7 +10055,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -10036,7 +10068,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -10057,7 +10089,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10099,7 +10131,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10108,7 +10140,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10142,7 +10174,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10152,7 +10184,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10180,13 +10212,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10279,13 +10311,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10332,16 +10364,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10350,35 +10373,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10401,23 +10396,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10429,20 +10407,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10453,13 +10417,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10470,16 +10427,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10511,18 +10458,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10546,2919 +10481,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14074,610 +11103,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14697,27 +11122,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14774,25 +11178,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14862,24 +11247,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14904,24 +11271,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -14946,24 +11295,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -14984,44 +11315,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15077,29 +11371,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15144,27 +11415,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15180,30 +11430,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15236,30 +11462,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15400,30 +11602,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15463,30 +11641,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index 2e3ff58..33a7d34 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,38 +1603,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1620,8 +1653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1635,8 +1668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1650,8 +1683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1665,8 +1698,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1685,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1701,6 +1734,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1764,8 +1800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1779,8 +1815,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1794,8 +1830,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1845,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1829,8 +1865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1845,6 +1881,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1899,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1914,8 +1953,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1929,8 +1968,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1944,8 +1983,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1964,8 +2003,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1980,6 +2019,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2053,8 +2095,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2068,8 +2110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2083,8 +2125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2098,8 +2140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2118,8 +2160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2134,6 +2176,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2207,8 +2252,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2222,8 +2267,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2237,8 +2282,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2252,8 +2297,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2272,8 +2317,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2288,6 +2333,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2361,8 +2409,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2376,8 +2424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2391,8 +2439,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2406,8 +2454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2426,8 +2474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2442,6 +2490,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2515,8 +2566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2530,8 +2581,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2545,8 +2596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2560,8 +2611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2580,8 +2631,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2596,6 +2647,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2669,8 +2723,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2684,8 +2738,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2699,8 +2753,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2714,8 +2768,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2734,8 +2788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,7 +2839,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2904,13 +2958,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3182,6 +3236,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3440,10 +3504,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3669,38 +3729,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3851,13 +3879,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3945,13 +3973,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4019,13 +4047,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4047,7 +4075,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4076,7 +4104,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4113,13 +4141,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4142,41 +4170,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4313,7 +4341,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4323,7 +4351,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4416,7 +4444,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4483,12 +4511,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4497,13 +4525,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4517,19 +4545,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4540,12 +4568,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4554,17 +4582,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4587,7 +4615,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4631,12 +4659,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4649,12 +4677,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4662,37 +4690,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -5273,7 +5301,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5420,7 +5448,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5434,7 +5462,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5574,7 +5602,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5644,7 +5672,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5729,7 +5757,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6041,13 +6069,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6070,13 +6098,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6107,13 +6135,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6140,13 +6168,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6225,7 +6253,7 @@ "type" : "integer" }, "plans" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "items" : { "enum" : [ @@ -6237,13 +6265,13 @@ "type" : "array" }, "preselectedValue" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Preselected number of installments offered for this payment method.", "format" : "int32", "type" : "integer" }, "values" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`.", "items" : { "format" : "int32", @@ -6256,7 +6284,7 @@ "Installments" : { "properties" : { "plan" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "enum" : [ "regular", @@ -6315,13 +6343,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6410,16 +6438,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6683,13 +6701,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6717,13 +6735,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6754,7 +6772,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6764,7 +6782,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6802,13 +6820,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7090,7 +7108,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7138,14 +7156,14 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -7155,7 +7173,7 @@ }, "details" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.", "items" : { "$ref" : "#/components/schemas/InputDetail" @@ -7167,7 +7185,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7177,7 +7195,7 @@ }, "outputDetails" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -7187,7 +7205,7 @@ }, "paymentData" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action.paymentData` instead.", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.", "type" : "string" @@ -7202,7 +7220,7 @@ }, "redirect" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.", "$ref" : "#/components/schemas/Redirect" @@ -7212,7 +7230,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7239,7 +7257,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7295,13 +7313,13 @@ "type" : "string" }, "id" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "description" : "A unique identifier of the payment link.", "readOnly" : true, "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7374,7 +7392,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7396,7 +7414,7 @@ "PaymentMethod" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7418,7 +7436,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -7543,7 +7561,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7555,7 +7573,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7576,7 +7594,7 @@ "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -7586,12 +7604,12 @@ "type" : "string" }, "order" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Contains the order information which is required for partial payments.", "$ref" : "#/components/schemas/CheckoutOrder" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7600,14 +7618,14 @@ "type" : "string" }, "splitCardFundingSources" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "default" : false, "description" : "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", "type" : "boolean" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7641,7 +7659,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7698,7 +7716,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7761,12 +7779,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7775,7 +7793,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7790,12 +7808,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7804,7 +7822,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7818,40 +7836,40 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7865,13 +7883,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7882,7 +7900,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7891,17 +7909,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7921,7 +7939,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -8063,7 +8081,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8073,12 +8091,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8118,12 +8136,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8136,12 +8154,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8149,35 +8167,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8193,7 +8211,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8268,14 +8286,14 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -8285,7 +8303,7 @@ }, "details" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.", "items" : { "$ref" : "#/components/schemas/InputDetail" @@ -8297,7 +8315,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8307,7 +8325,7 @@ }, "outputDetails" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -8317,7 +8335,7 @@ }, "paymentData" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action.paymentData` instead.", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.", "type" : "string" @@ -8328,7 +8346,7 @@ }, "redirect" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.", "$ref" : "#/components/schemas/Redirect" @@ -8338,7 +8356,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8361,7 +8379,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8457,7 +8475,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8469,17 +8487,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8487,7 +8505,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8502,7 +8520,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8511,7 +8529,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8520,7 +8538,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8534,34 +8552,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8575,13 +8593,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8592,7 +8610,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8601,12 +8619,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8643,7 +8661,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8670,12 +8688,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8688,12 +8706,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8701,24 +8719,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8728,7 +8746,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8835,7 +8853,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8910,13 +8928,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8950,18 +8968,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8974,7 +8992,7 @@ "RecurringDetail" : { "properties" : { "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8996,7 +9014,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -9077,6 +9095,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9268,6 +9290,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9313,7 +9346,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9326,12 +9359,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9574,7 +9607,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9584,7 +9617,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9615,13 +9648,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9643,7 +9676,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9889,13 +9922,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9913,7 +9946,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9962,18 +9994,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9998,12 +10030,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -10043,7 +10075,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -10064,7 +10096,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -10076,7 +10108,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -10092,7 +10124,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -10105,7 +10137,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -10126,7 +10158,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10168,7 +10200,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10177,7 +10209,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10211,7 +10243,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10221,7 +10253,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10249,13 +10281,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10348,13 +10380,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10401,16 +10433,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10419,35 +10442,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10470,23 +10465,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10498,20 +10476,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10522,13 +10486,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10539,16 +10496,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10580,18 +10527,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10615,2919 +10550,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14143,610 +11172,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14766,27 +11191,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14843,25 +11247,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14931,24 +11316,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14973,24 +11340,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -15015,24 +11364,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -15053,44 +11384,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15146,29 +11440,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15213,27 +11484,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15249,30 +11499,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15305,30 +11531,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15469,30 +11671,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15532,30 +11710,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index dbfbe5e..7031e72 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,38 +1603,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1620,8 +1653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1635,8 +1668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1650,8 +1683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1665,8 +1698,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1685,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1701,6 +1734,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1764,8 +1800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1779,8 +1815,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1794,8 +1830,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1845,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1829,8 +1865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1845,6 +1881,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1899,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1914,8 +1953,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1929,8 +1968,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1944,8 +1983,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1964,8 +2003,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1980,6 +2019,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2053,8 +2095,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2068,8 +2110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2083,8 +2125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2098,8 +2140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2118,8 +2160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2134,6 +2176,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2207,8 +2252,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2222,8 +2267,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2237,8 +2282,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2252,8 +2297,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2272,8 +2317,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2288,6 +2333,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2361,8 +2409,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2376,8 +2424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2391,8 +2439,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2406,8 +2454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2426,8 +2474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2442,6 +2490,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2515,8 +2566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2530,8 +2581,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2545,8 +2596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2560,8 +2611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2580,8 +2631,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2596,6 +2647,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2669,8 +2723,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2684,8 +2738,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2699,8 +2753,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2714,8 +2768,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2734,8 +2788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,7 +2839,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2904,13 +2958,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3182,6 +3236,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3440,10 +3504,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3669,38 +3729,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3851,13 +3879,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3945,13 +3973,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4018,29 +4046,29 @@ "additionalProperties" : false, "properties" : { "bankAccountNumber" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The bank account number (without separators).", "type" : "string" }, "bankLocationId" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The bank routing number of the account.", "type" : "string" }, "holderName" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The name of the bank account holder.", "type" : "string" }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4062,7 +4090,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4091,7 +4119,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4128,13 +4156,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4157,41 +4185,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4328,7 +4356,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4338,7 +4366,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4431,7 +4459,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4498,12 +4526,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4512,13 +4540,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4532,13 +4560,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4549,12 +4577,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4563,17 +4591,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4596,7 +4624,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4640,12 +4668,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4658,12 +4686,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4671,37 +4699,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4780,7 +4808,7 @@ "type" : "string" }, "transactionLimit" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The maximum spendable balance for a single transaction. Applicable to some gift cards.", "$ref" : "#/components/schemas/Amount" } @@ -5287,7 +5315,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5434,7 +5462,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5448,7 +5476,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5588,7 +5616,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5631,7 +5659,7 @@ "type" : "boolean" }, "riskData" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Any risk-related settings to apply to the payment.", "$ref" : "#/components/schemas/RiskData" }, @@ -5663,7 +5691,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5748,7 +5776,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6060,13 +6088,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6089,13 +6117,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6126,13 +6154,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6159,13 +6187,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6244,7 +6272,7 @@ "type" : "integer" }, "plans" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "items" : { "enum" : [ @@ -6256,13 +6284,13 @@ "type" : "array" }, "preselectedValue" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Preselected number of installments offered for this payment method.", "format" : "int32", "type" : "integer" }, "values" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`.", "items" : { "format" : "int32", @@ -6275,7 +6303,7 @@ "Installments" : { "properties" : { "plan" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "enum" : [ "regular", @@ -6334,13 +6362,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6429,16 +6457,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6702,13 +6720,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6736,13 +6754,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6773,7 +6791,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6783,7 +6801,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6821,13 +6839,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7109,7 +7127,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7157,14 +7175,14 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -7174,7 +7192,7 @@ }, "details" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.", "items" : { "$ref" : "#/components/schemas/InputDetail" @@ -7186,7 +7204,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7196,7 +7214,7 @@ }, "outputDetails" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -7206,7 +7224,7 @@ }, "paymentData" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action.paymentData` instead.", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.", "type" : "string" @@ -7221,7 +7239,7 @@ }, "redirect" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.", "$ref" : "#/components/schemas/Redirect" @@ -7231,7 +7249,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7258,7 +7276,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7314,13 +7332,13 @@ "type" : "string" }, "id" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "description" : "A unique identifier of the payment link.", "readOnly" : true, "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7356,7 +7374,7 @@ "type" : "boolean" }, "riskData" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Any risk-related settings to apply to the payment.", "$ref" : "#/components/schemas/RiskData" }, @@ -7398,7 +7416,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7420,12 +7438,12 @@ "PaymentMethod" : { "properties" : { "brand" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Brand for the selected gift card. For example: plastix, hmclub.", "type" : "string" }, "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7447,7 +7465,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -7549,7 +7567,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7561,7 +7579,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7586,12 +7604,12 @@ "type" : "string" }, "order" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Contains the order information which is required for partial payments.", "$ref" : "#/components/schemas/CheckoutOrder" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7600,14 +7618,14 @@ "type" : "string" }, "splitCardFundingSources" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "default" : false, "description" : "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", "type" : "boolean" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7627,7 +7645,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7684,7 +7702,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7747,12 +7765,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7761,7 +7779,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7776,12 +7794,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7790,7 +7808,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7804,34 +7822,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7845,13 +7863,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7862,7 +7880,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7871,17 +7889,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7901,7 +7919,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -8043,7 +8061,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8053,12 +8071,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8098,12 +8116,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8116,12 +8134,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8129,35 +8147,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8173,7 +8191,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8248,14 +8266,14 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -8265,7 +8283,7 @@ }, "details" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.", "items" : { "$ref" : "#/components/schemas/InputDetail" @@ -8277,7 +8295,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8287,7 +8305,7 @@ }, "outputDetails" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -8297,7 +8315,7 @@ }, "paymentData" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action.paymentData` instead.", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.", "type" : "string" @@ -8308,7 +8326,7 @@ }, "redirect" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.", "$ref" : "#/components/schemas/Redirect" @@ -8318,7 +8336,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8341,7 +8359,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8437,7 +8455,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8449,17 +8467,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8467,7 +8485,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8482,7 +8500,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8491,7 +8509,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8500,7 +8518,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8514,28 +8532,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8549,13 +8567,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8566,7 +8584,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8575,12 +8593,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8617,7 +8635,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8644,12 +8662,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8662,12 +8680,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8675,24 +8693,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8702,7 +8720,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8809,7 +8827,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8884,13 +8902,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8924,18 +8942,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8948,12 +8966,12 @@ "RecurringDetail" : { "properties" : { "brand" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Brand for the selected gift card. For example: plastix, hmclub.", "type" : "string" }, "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8975,7 +8993,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -9052,6 +9070,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9243,6 +9265,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9280,7 +9313,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9293,12 +9326,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9508,7 +9541,7 @@ "type" : "string" }, "customFields" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "additionalProperties" : { "type" : "string" }, @@ -9516,13 +9549,13 @@ "type" : "object" }, "fraudOffset" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.", "format" : "int32", "type" : "integer" }, "profileReference" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "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" } @@ -9560,7 +9593,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9570,7 +9603,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9601,13 +9634,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9629,7 +9662,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9875,13 +9908,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9899,7 +9932,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9948,18 +9980,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9984,12 +10016,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -10029,7 +10061,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -10050,7 +10082,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -10062,7 +10094,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -10078,7 +10110,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -10091,7 +10123,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -10112,7 +10144,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10154,7 +10186,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10163,7 +10195,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10197,7 +10229,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10207,7 +10239,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10235,13 +10267,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10334,13 +10366,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10387,16 +10419,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10405,37 +10428,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security", - "pspReference" : "881611827877203B" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation", - "pspReference" : "8816118280275544" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10458,23 +10451,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10486,20 +10462,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10510,13 +10472,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10527,16 +10482,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10568,18 +10513,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10603,2919 +10536,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14131,610 +11158,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14754,27 +11177,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14831,25 +11233,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14919,24 +11302,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14961,24 +11326,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -15003,24 +11350,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -15041,44 +11370,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15134,29 +11426,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15201,27 +11470,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15237,30 +11485,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15293,30 +11517,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15457,30 +11657,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15520,30 +11696,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 0fa6f67..7814a3b 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +176,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +218,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +238,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +253,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +268,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +283,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +303,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +319,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +361,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +381,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +396,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +411,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +426,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,6 +462,9 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "operationId" : "post-originKeys", @@ -492,8 +504,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -512,8 +524,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -527,8 +539,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -542,8 +554,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -557,8 +569,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -577,8 +589,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -593,6 +605,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -632,8 +647,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -667,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -682,8 +697,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -697,8 +712,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -712,8 +727,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -732,8 +747,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -748,6 +763,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -782,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -802,8 +820,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -817,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -832,8 +850,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -847,8 +865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -867,8 +885,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -881,6 +899,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -929,8 +950,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -949,8 +970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -964,8 +985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -979,8 +1000,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -994,8 +1015,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1014,8 +1035,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1030,6 +1051,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1075,14 +1099,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1101,8 +1125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1131,8 +1155,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1146,8 +1170,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1166,8 +1190,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1182,6 +1206,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1224,8 +1251,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1244,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1259,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1274,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1289,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1309,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1325,6 +1352,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1376,11 +1406,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1399,8 +1429,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1414,8 +1444,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1429,8 +1459,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1444,8 +1474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1464,8 +1494,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1480,6 +1510,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1570,38 +1603,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1620,8 +1653,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1635,8 +1668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1650,8 +1683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1665,8 +1698,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1685,8 +1718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1701,6 +1734,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1764,8 +1800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1779,8 +1815,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1794,8 +1830,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1809,8 +1845,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1829,8 +1865,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1845,6 +1881,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1899,8 +1938,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1914,8 +1953,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1929,8 +1968,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1944,8 +1983,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1964,8 +2003,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1980,6 +2019,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2053,8 +2095,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2068,8 +2110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2083,8 +2125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2098,8 +2140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2118,8 +2160,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2134,6 +2176,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2207,8 +2252,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2222,8 +2267,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2237,8 +2282,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2252,8 +2297,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2272,8 +2317,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2288,6 +2333,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2361,8 +2409,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2376,8 +2424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2391,8 +2439,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2406,8 +2454,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2426,8 +2474,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2442,6 +2490,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2515,8 +2566,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2530,8 +2581,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2545,8 +2596,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2560,8 +2611,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2580,8 +2631,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2596,6 +2647,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2669,8 +2723,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2684,8 +2738,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2699,8 +2753,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2714,8 +2768,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2734,8 +2788,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2785,7 +2839,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2904,13 +2958,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3182,6 +3236,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3440,10 +3504,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3669,38 +3729,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3851,13 +3879,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3945,13 +3973,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4018,29 +4046,29 @@ "additionalProperties" : false, "properties" : { "bankAccountNumber" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The bank account number (without separators).", "type" : "string" }, "bankLocationId" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The bank routing number of the account.", "type" : "string" }, "holderName" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The name of the bank account holder.", "type" : "string" }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4062,7 +4090,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4091,7 +4119,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4128,13 +4156,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4157,41 +4185,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4328,7 +4356,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4338,7 +4366,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4431,7 +4459,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4498,12 +4526,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4512,13 +4540,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4532,13 +4560,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4549,12 +4577,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4563,17 +4591,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4596,7 +4624,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4640,12 +4668,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4658,12 +4686,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4671,37 +4699,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4780,7 +4808,7 @@ "type" : "string" }, "transactionLimit" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The maximum spendable balance for a single transaction. Applicable to some gift cards.", "$ref" : "#/components/schemas/Amount" } @@ -5287,7 +5315,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5434,7 +5462,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5448,7 +5476,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5588,7 +5616,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5631,7 +5659,7 @@ "type" : "boolean" }, "riskData" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Any risk-related settings to apply to the payment.", "$ref" : "#/components/schemas/RiskData" }, @@ -5663,7 +5691,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5748,7 +5776,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -6060,13 +6088,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6089,13 +6117,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6126,13 +6154,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6159,13 +6187,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6244,7 +6272,7 @@ "type" : "integer" }, "plans" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "items" : { "enum" : [ @@ -6256,13 +6284,13 @@ "type" : "array" }, "preselectedValue" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Preselected number of installments offered for this payment method.", "format" : "int32", "type" : "integer" }, "values" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`.", "items" : { "format" : "int32", @@ -6275,7 +6303,7 @@ "Installments" : { "properties" : { "plan" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "enum" : [ "regular", @@ -6334,13 +6362,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6429,16 +6457,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6702,13 +6720,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6736,13 +6754,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6773,7 +6791,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6783,7 +6801,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6821,13 +6839,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7109,7 +7127,7 @@ "PaymentDetailsResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.", "oneOf" : [ { @@ -7157,14 +7175,14 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -7174,7 +7192,7 @@ }, "details" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.", "items" : { "$ref" : "#/components/schemas/InputDetail" @@ -7182,7 +7200,7 @@ "type" : "array" }, "donationToken" : { - "x-addedInVersion" : 66, + "x-addedInVersion" : "66", "description" : "Donation Token containing payment details for Adyen Giving.", "type" : "string" }, @@ -7191,7 +7209,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7201,7 +7219,7 @@ }, "outputDetails" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -7211,7 +7229,7 @@ }, "paymentData" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action.paymentData` instead.", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.", "type" : "string" @@ -7226,7 +7244,7 @@ }, "redirect" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.", "$ref" : "#/components/schemas/Redirect" @@ -7236,7 +7254,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7263,7 +7281,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -7319,13 +7337,13 @@ "type" : "string" }, "id" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "description" : "A unique identifier of the payment link.", "readOnly" : true, "type" : "string" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7361,7 +7379,7 @@ "type" : "boolean" }, "riskData" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Any risk-related settings to apply to the payment.", "$ref" : "#/components/schemas/RiskData" }, @@ -7403,7 +7421,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, @@ -7425,12 +7443,12 @@ "PaymentMethod" : { "properties" : { "brand" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Brand for the selected gift card. For example: plastix, hmclub.", "type" : "string" }, "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -7452,7 +7470,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -7554,7 +7572,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7566,7 +7584,7 @@ "$ref" : "#/components/schemas/Amount" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -7591,12 +7609,12 @@ "type" : "string" }, "order" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Contains the order information which is required for partial payments.", "$ref" : "#/components/schemas/CheckoutOrder" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, @@ -7605,14 +7623,14 @@ "type" : "string" }, "splitCardFundingSources" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "default" : false, "description" : "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", "type" : "boolean" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -7632,7 +7650,7 @@ "type" : "array" }, "storedPaymentMethods" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of all stored payment methods.", "items" : { "$ref" : "#/components/schemas/StoredPaymentMethod" @@ -7689,7 +7707,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7752,12 +7770,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7766,7 +7784,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7781,12 +7799,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7795,7 +7813,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7809,34 +7827,34 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7850,13 +7868,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7867,7 +7885,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7876,17 +7894,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7906,7 +7924,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -8048,7 +8066,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -8058,12 +8076,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8103,12 +8121,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8121,12 +8139,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8134,35 +8152,35 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8178,7 +8196,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8253,14 +8271,14 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "authentication" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -8270,7 +8288,7 @@ }, "details" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.", "items" : { "$ref" : "#/components/schemas/InputDetail" @@ -8278,7 +8296,7 @@ "type" : "array" }, "donationToken" : { - "x-addedInVersion" : 66, + "x-addedInVersion" : "66", "description" : "Donation Token containing payment details for Adyen Giving.", "type" : "string" }, @@ -8287,7 +8305,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8297,7 +8315,7 @@ }, "outputDetails" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "additionalProperties" : { "type" : "string" @@ -8307,7 +8325,7 @@ }, "paymentData" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action.paymentData` instead.", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.", "type" : "string" @@ -8318,7 +8336,7 @@ }, "redirect" : { "deprecated" : true, - "x-deprecatedInVersion" : 64, + "x-deprecatedInVersion" : "64", "x-deprecatedMessage" : "Use `action` instead.", "description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.", "$ref" : "#/components/schemas/Redirect" @@ -8328,7 +8346,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8351,7 +8369,7 @@ "type" : "string" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" } @@ -8447,7 +8465,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8459,17 +8477,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8477,7 +8495,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8492,7 +8510,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8501,7 +8519,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8510,7 +8528,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8524,28 +8542,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8559,13 +8577,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8576,7 +8594,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8585,12 +8603,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8627,7 +8645,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8654,12 +8672,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8672,12 +8690,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8685,24 +8703,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8712,7 +8730,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8819,7 +8837,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8894,13 +8912,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8934,18 +8952,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8958,12 +8976,12 @@ "RecurringDetail" : { "properties" : { "brand" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Brand for the selected gift card. For example: plastix, hmclub.", "type" : "string" }, "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8985,7 +9003,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -9062,6 +9080,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9253,6 +9275,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9290,7 +9323,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9303,12 +9336,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9518,7 +9551,7 @@ "type" : "string" }, "customFields" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "additionalProperties" : { "type" : "string" }, @@ -9526,13 +9559,13 @@ "type" : "object" }, "fraudOffset" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.", "format" : "int32", "type" : "integer" }, "profileReference" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "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" } @@ -9570,7 +9603,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9580,7 +9613,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9611,13 +9644,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9639,7 +9672,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9885,13 +9918,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9909,7 +9942,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9958,18 +9990,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9994,12 +10026,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -10039,7 +10071,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -10060,7 +10092,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -10072,7 +10104,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -10088,7 +10120,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -10101,7 +10133,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -10122,7 +10154,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10164,7 +10196,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10173,7 +10205,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -10207,7 +10239,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10217,7 +10249,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10245,13 +10277,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10344,13 +10376,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10397,16 +10429,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10415,37 +10438,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security", - "pspReference" : "881611827877203B" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation", - "pspReference" : "8816118280275544" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10468,23 +10461,6 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 8700 - }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" - } - }, "post-orders-basic" : { "summary" : "Create an order", "value" : { @@ -10496,20 +10472,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10520,13 +10482,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10537,16 +10492,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10578,18 +10523,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10613,2919 +10546,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14141,610 +11168,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14764,27 +11187,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14841,25 +11243,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14929,24 +11312,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14971,24 +11336,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -15013,24 +11360,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -15051,44 +11380,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15144,29 +11436,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15211,27 +11480,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15247,30 +11495,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15303,30 +11527,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15467,30 +11667,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15530,30 +11706,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index 2cc9898..88d6059 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -28,6 +28,9 @@ "paths" : { "/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-cancels", @@ -92,8 +95,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -107,8 +110,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -122,8 +125,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -137,8 +140,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -157,8 +160,152 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/donations" : { + "post" : { + "tags" : [ + "Payments" + ], + "summary" : "Starts a transaction for donation.", + "description" : "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request.\n\nFor more information, see [Donations](https://docs.adyen.com/online-payments/donations).", + "x-addedInVersion" : "67", + "operationId" : "post-donations", + "x-groupName" : "Payments", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "donations" : { + "$ref" : "#/components/examples/post-donations-donations" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PaymentDonationRequest" + } + } + } + }, + "parameters" : [ + { + "$ref" : "#/components/parameters/Idempotency-Key" + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "donations" : { + "$ref" : "#/components/examples/post-donations-donations" + } + }, + "schema" : { + "$ref" : "#/components/schemas/DonationResponse" + } + } + }, + "description" : "OK - the request has succeeded.", + "headers" : { + "Idempotency-Key" : { + "$ref" : "#/components/headers/Idempotency-Key" + } + } + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error.", + "headers" : { + "Idempotency-Key" : { + "$ref" : "#/components/headers/Idempotency-Key" + } + } + }, + "500" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -173,6 +320,9 @@ }, "/orders" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Creates an order for the given amount.", "description" : "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.", "operationId" : "post-orders", @@ -212,8 +362,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-basic" } }, "schema" : { @@ -232,8 +382,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -247,8 +397,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -262,8 +412,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -277,8 +427,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +447,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -313,6 +463,9 @@ }, "/orders/cancel" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Cancels the given order.", "description" : "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.", "operationId" : "post-orders-cancel", @@ -352,8 +505,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-orders-cancel-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-orders-cancel-basic" } }, "schema" : { @@ -372,8 +525,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -387,8 +540,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -402,8 +555,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -417,8 +570,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -437,8 +590,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -453,10 +606,13 @@ }, "/originKeys" : { "post" : { + "tags" : [ + "Utility" + ], "summary" : "Create originKey values for one or more merchant domains.", "description" : "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. \n> If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ", "deprecated" : true, - "x-deprecatedInVersion" : 67, + "x-deprecatedInVersion" : "67", "operationId" : "post-originKeys", "x-groupName" : "Utility", "x-sortIndex" : 1, @@ -494,8 +650,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-originKeys-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-originKeys-basic" } }, "schema" : { @@ -514,8 +670,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -529,8 +685,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -544,8 +700,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -559,8 +715,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -579,8 +735,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -595,6 +751,9 @@ }, "/paymentLinks" : { "post" : { + "tags" : [ + "Payment links" + ], "summary" : "Creates a payment link.", "description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).", "operationId" : "post-paymentLinks", @@ -634,8 +793,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentLinks-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentLinks-basic" } }, "schema" : { @@ -669,8 +828,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -684,8 +843,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -699,8 +858,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -714,8 +873,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -734,8 +893,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -750,6 +909,9 @@ }, "/paymentLinks/{linkId}" : { "get" : { + "tags" : [ + "Payment links" + ], "summary" : "Retrieve a payment link.", "description" : "Retrieves the payment link details using the payment link `id`.", "operationId" : "get-paymentLinks-linkId", @@ -784,8 +946,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/get-paymentLinks-linkId-basic" } }, "schema" : { @@ -804,8 +966,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -819,8 +981,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -834,8 +996,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -849,8 +1011,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -869,8 +1031,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -883,6 +1045,9 @@ } }, "patch" : { + "tags" : [ + "Payment links" + ], "summary" : "Update the status of a payment link", "description" : "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).", "operationId" : "patch-paymentLinks-linkId", @@ -931,8 +1096,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200" + "basic" : { + "$ref" : "#/components/examples/patch-paymentLinks-linkId-basic" } }, "schema" : { @@ -951,8 +1116,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -966,8 +1131,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -981,8 +1146,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -996,8 +1161,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1016,8 +1181,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1032,6 +1197,9 @@ }, "/paymentMethods" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Returns available payment methods.", "description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.", "operationId" : "post-paymentMethods", @@ -1077,14 +1245,14 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-paymentMethods-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-paymentMethods-basic" }, - "filtered-200" : { - "$ref" : "#/components/examples/post-paymentMethods-filtered-200" + "filtered" : { + "$ref" : "#/components/examples/post-paymentMethods-filtered" }, - "include-oneclick-200" : { - "$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200" + "include-oneclick" : { + "$ref" : "#/components/examples/post-paymentMethods-include-oneclick" } }, "schema" : { @@ -1103,8 +1271,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1118,8 +1286,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1133,8 +1301,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1148,8 +1316,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1168,8 +1336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1184,6 +1352,9 @@ }, "/paymentMethods/balance" : { "post" : { + "tags" : [ + "Orders" + ], "summary" : "Returns the available balance on gift card.", "description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.", "operationId" : "post-paymentMethods-balance", @@ -1226,8 +1397,8 @@ "content" : { "application/json" : { "examples" : { - "plastix-200" : { - "$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200" + "plastix" : { + "$ref" : "#/components/examples/post-paymentMethods-balance-plastix" } }, "schema" : { @@ -1246,8 +1417,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1261,8 +1432,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1276,8 +1447,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1291,8 +1462,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1311,8 +1482,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1327,6 +1498,9 @@ }, "/paymentSession" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Creates 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).", "operationId" : "post-paymentSession", @@ -1378,11 +1552,11 @@ "content" : { "application/json" : { "examples" : { - "enableOneClick-200" : { - "$ref" : "#/components/examples/post-paymentSession-enableOneClick-200" + "enableOneClick" : { + "$ref" : "#/components/examples/post-paymentSession-enableOneClick" }, - "web-200" : { - "$ref" : "#/components/examples/post-paymentSession-web-200" + "web" : { + "$ref" : "#/components/examples/post-paymentSession-web" } }, "schema" : { @@ -1401,8 +1575,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1416,8 +1590,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1431,8 +1605,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1446,8 +1620,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1466,8 +1640,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1482,6 +1656,9 @@ }, "/payments" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Starts a transaction.", "description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ", "operationId" : "post-payments", @@ -1572,38 +1749,38 @@ "content" : { "application/json" : { "examples" : { - "card-3d-secure-2-web-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web-200" + "card-3d-secure-2-web" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-2-web" }, - "card-3d-secure-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-direct-200" + "card-3d-secure-direct" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-direct" }, - "card-3d-secure-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields-200" + "card-3d-secure-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-3d-secure-securedfields" }, - "card-direct-200" : { - "$ref" : "#/components/examples/post-payments-card-direct-200" + "card-direct" : { + "$ref" : "#/components/examples/post-payments-card-direct" }, - "card-securedfields-200" : { - "$ref" : "#/components/examples/post-payments-card-securedfields-200" + "card-securedfields" : { + "$ref" : "#/components/examples/post-payments-card-securedfields" }, - "enableOneClick-SF-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-SF-200" + "enableOneClick-SF" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-SF" }, - "enableOneClick-raw-200" : { - "$ref" : "#/components/examples/post-payments-enableOneClick-raw-200" + "enableOneClick-raw" : { + "$ref" : "#/components/examples/post-payments-enableOneClick-raw" }, - "giropay-200" : { - "$ref" : "#/components/examples/post-payments-giropay-200" + "giropay" : { + "$ref" : "#/components/examples/post-payments-giropay" }, - "ideal-200" : { - "$ref" : "#/components/examples/post-payments-ideal-200" + "ideal" : { + "$ref" : "#/components/examples/post-payments-ideal" }, - "sofort-200" : { - "$ref" : "#/components/examples/post-payments-sofort-200" + "sofort" : { + "$ref" : "#/components/examples/post-payments-sofort" }, - "subscription-first-transaction-200" : { - "$ref" : "#/components/examples/post-payments-subscription-first-transaction-200" + "subscription-first-transaction" : { + "$ref" : "#/components/examples/post-payments-subscription-first-transaction" } }, "schema" : { @@ -1622,8 +1799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1637,8 +1814,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1652,8 +1829,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1667,8 +1844,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1687,8 +1864,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1703,6 +1880,9 @@ }, "/payments/details" : { "post" : { + "tags" : [ + "Payments" + ], "summary" : "Submits details for a payment.", "description" : "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.\n\n", "operationId" : "post-payments-details", @@ -1760,8 +1940,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1775,8 +1955,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1790,8 +1970,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1805,8 +1985,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1825,8 +2005,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1841,6 +2021,9 @@ }, "/payments/result" : { "post" : { + "tags" : [ + "Classic Checkout SDK" + ], "summary" : "Verifies 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).", "operationId" : "post-payments-result", @@ -1895,8 +2078,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1910,8 +2093,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1925,8 +2108,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1940,8 +2123,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1960,8 +2143,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1976,6 +2159,9 @@ }, "/payments/{paymentPspReference}/amountUpdates" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).\n\nYou can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).\n\nThe amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.\n\nFor more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).", "operationId" : "post-payments-paymentPspReference-amountUpdates", @@ -2049,8 +2235,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2064,8 +2250,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2079,8 +2265,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2094,8 +2280,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2114,8 +2300,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2130,6 +2316,9 @@ }, "/payments/{paymentPspReference}/cancels" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).\n\nIf you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.\n\nIf you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).", "operationId" : "post-payments-paymentPspReference-cancels", @@ -2203,8 +2392,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2218,8 +2407,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2233,8 +2422,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2248,8 +2437,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2268,8 +2457,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2284,6 +2473,9 @@ }, "/payments/{paymentPspReference}/captures" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).", "operationId" : "post-payments-paymentPspReference-captures", @@ -2357,8 +2549,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2372,8 +2564,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2387,8 +2579,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2402,8 +2594,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2422,8 +2614,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2438,6 +2630,9 @@ }, "/payments/{paymentPspReference}/refunds" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).", "operationId" : "post-payments-paymentPspReference-refunds", @@ -2511,8 +2706,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2526,8 +2721,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2541,8 +2736,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2556,8 +2751,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2576,8 +2771,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2592,6 +2787,9 @@ }, "/payments/{paymentPspReference}/reversals" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).\n\nThe reversed amount is always the full payment amount.\n> Do not use this request for payments that involve multiple partial captures.\n\nFor more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).", "operationId" : "post-payments-paymentPspReference-reversals", @@ -2665,8 +2863,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2680,8 +2878,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2695,8 +2893,8 @@ "content" : { "application/json" : { "examples" : { - "generic-403" : { - "$ref" : "#/components/examples/generic-403" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2710,8 +2908,8 @@ "content" : { "application/json" : { "examples" : { - "generic-422" : { - "$ref" : "#/components/examples/generic-422" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2730,8 +2928,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -2781,7 +2979,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -2900,13 +3098,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3178,6 +3376,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -3436,10 +3644,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -3665,38 +3869,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -3847,13 +4019,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -3941,13 +4113,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4014,29 +4186,29 @@ "additionalProperties" : false, "properties" : { "bankAccountNumber" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The bank account number (without separators).", "type" : "string" }, "bankLocationId" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The bank routing number of the account.", "type" : "string" }, "holderName" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The name of the bank account holder.", "type" : "string" }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4058,7 +4230,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -4087,7 +4259,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -4124,13 +4296,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4153,41 +4325,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -4324,7 +4496,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -4334,7 +4506,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -4427,7 +4599,7 @@ "CheckoutBalanceCheckRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4494,12 +4666,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4508,13 +4680,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4528,13 +4700,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4545,12 +4717,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4559,17 +4731,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4592,7 +4764,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4636,12 +4808,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4654,12 +4826,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4667,37 +4839,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4776,7 +4948,7 @@ "type" : "string" }, "transactionLimit" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "The maximum spendable balance for a single transaction. Applicable to some gift cards.", "$ref" : "#/components/schemas/Amount" } @@ -5256,7 +5428,7 @@ "CheckoutUtilityResponse" : { "properties" : { "originKeys" : { - "x-addedInVersion" : 1, + "x-addedInVersion" : "1", "additionalProperties" : { "type" : "string" }, @@ -5403,7 +5575,7 @@ "$ref" : "#/components/schemas/Avs" }, "cardHolderName" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED", "enum" : [ "NONE", @@ -5417,7 +5589,7 @@ "$ref" : "#/components/schemas/InstallmentsNumber" }, "shopperInput" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Determines how to display the details fields.", "$ref" : "#/components/schemas/ShopperInput" } @@ -5557,7 +5729,7 @@ "type" : "object" }, "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -5592,7 +5764,7 @@ "type" : "string" }, "requiredShopperFields" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/online-payments/pay-by-link/api#shopper-information).\n\nPossible values:\n* **billingAddress** – The address where to send the invoice.\n* **deliveryAddress** – The address where the purchased goods should be delivered.\n* **shopperEmail** – The shopper's email address.\n* **shopperName** – The shopper's full name.\n* **telephoneNumber** – The shopper's phone number.\n", "items" : { "enum" : [ @@ -5615,7 +5787,7 @@ "type" : "boolean" }, "riskData" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Any risk-related settings to apply to the payment.", "$ref" : "#/components/schemas/RiskData" }, @@ -5647,7 +5819,7 @@ "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead.", "type" : "boolean" } @@ -5732,7 +5904,7 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.", "type" : "boolean" } @@ -5811,6 +5983,50 @@ ], "title" : "Doku" }, + "DonationResponse" : { + "properties" : { + "amount" : { + "x-addedInVersion" : "67", + "description" : "Authorised amount in the transaction.", + "$ref" : "#/components/schemas/Amount" + }, + "donationAccount" : { + "x-addedInVersion" : "67", + "description" : "The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding).", + "type" : "string" + }, + "id" : { + "x-addedInVersion" : "67", + "description" : "Your unique resource identifier.", + "type" : "string" + }, + "merchantAccount" : { + "x-addedInVersion" : "67", + "description" : "The merchant account identifier, with which you want to process the transaction.", + "type" : "string" + }, + "payment" : { + "x-addedInVersion" : "67", + "description" : "Action to be taken for completing the payment.", + "$ref" : "#/components/schemas/PaymentResponse" + }, + "reference" : { + "x-addedInVersion" : "67", + "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.", + "type" : "string" + }, + "status" : { + "x-addedInVersion" : "67", + "description" : "The status of the donation transaction.\n\nPossible values:\n* **completed**\n* **pending**\n* **refused**", + "enum" : [ + "completed", + "pending", + "refused" + ], + "type" : "string" + } + } + }, "DotpayDetails" : { "additionalProperties" : false, "properties" : { @@ -6044,13 +6260,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6073,13 +6289,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6110,13 +6326,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6143,13 +6359,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6228,7 +6444,7 @@ "type" : "integer" }, "plans" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "items" : { "enum" : [ @@ -6240,13 +6456,13 @@ "type" : "array" }, "preselectedValue" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Preselected number of installments offered for this payment method.", "format" : "int32", "type" : "integer" }, "values" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`.", "items" : { "format" : "int32", @@ -6259,7 +6475,7 @@ "Installments" : { "properties" : { "plan" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "enum" : [ "regular", @@ -6318,13 +6534,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6413,16 +6629,6 @@ "format" : "int64", "type" : "integer" }, - "taxCategory" : { - "description" : "Required for AfterPay. Tax category: High, Low, None, Zero", - "enum" : [ - "High", - "Low", - "None", - "Zero" - ], - "type" : "string" - }, "taxPercentage" : { "description" : "Tax percentage, in minor units.", "format" : "int64", @@ -6686,13 +6892,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6720,13 +6926,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6757,7 +6963,7 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -6767,7 +6973,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -6805,13 +7011,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -7132,12 +7338,12 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "donationToken" : { - "x-addedInVersion" : 66, + "x-addedInVersion" : "66", "description" : "Donation Token containing payment details for Adyen Giving.", "type" : "string" }, @@ -7146,7 +7352,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference used during the /payments request.", "type" : "string" }, @@ -7167,7 +7373,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -7194,443 +7400,26 @@ "type" : "string" }, "threeDS2ResponseData" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "Response of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2ResponseData" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" }, "threeDSPaymentData" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } } }, - "PaymentLinkResource" : { - "properties" : { - "allowedPaymentMethods" : { - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "amount" : { - "description" : "The payment amount and currency.", - "$ref" : "#/components/schemas/Amount" - }, - "applicationInfo" : { - "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" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "blockedPaymentMethods" : { - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "countryCode" : { - "description" : "The shopper's two-letter country code.", - "type" : "string" - }, - "deliverAt" : { - "description" : "The date and time the purchased goods should be delivered. In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddress" : { - "description" : "The address where the purchased goods should be delivered.", - "$ref" : "#/components/schemas/Address" - }, - "description" : { - "description" : "A short description visible on the payment page.\nMaximum length: 280 characters.", - "type" : "string" - }, - "expiresAt" : { - "description" : "The date that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 70 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created.", - "type" : "string" - }, - "id" : { - "x-addedInVersion" : 51, - "description" : "A unique identifier of the payment link.", - "readOnly" : true, - "type" : "string" - }, - "lineItems" : { - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.", - "items" : { - "$ref" : "#/components/schemas/LineItem" - }, - "type" : "array" - }, - "merchantAccount" : { - "description" : "The merchant account identifier for which the payment link is created.", - "type" : "string" - }, - "merchantOrderReference" : { - "description" : "This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.", - "type" : "string" - }, - "recurringProcessingModel" : { - "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", - "enum" : [ - "CardOnFile", - "Subscription", - "UnscheduledCardOnFile" - ], - "type" : "string" - }, - "reference" : { - "description" : "A reference that is used to uniquely identify the payment in future communications about the payment status.", - "type" : "string" - }, - "returnUrl" : { - "description" : "Website URL used for redirection after payment is completed.\nIf provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.", - "type" : "string" - }, - "reusable" : { - "description" : "Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.", - "type" : "boolean" - }, - "riskData" : { - "x-addedInVersion" : 65, - "description" : "Any risk-related settings to apply to the payment.", - "$ref" : "#/components/schemas/RiskData" - }, - "shopperEmail" : { - "description" : "The shopper's email address.", - "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).", - "type" : "string" - }, - "shopperName" : { - "description" : "The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.", - "$ref" : "#/components/schemas/Name" - }, - "shopperReference" : { - "description" : "A unique identifier for the shopper (for example, user ID or account ID).", - "type" : "string" - }, - "splits" : { - "description" : "An array of objects specifying how the payment should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", - "items" : { - "$ref" : "#/components/schemas/Split" - }, - "type" : "array" - }, - "status" : { - "description" : "Status of the payment link. Possible values:\n* **active** \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and below)", - "enum" : [ - "active", - "completed", - "expired", - "paymentPending" - ], - "type" : "string" - }, - "store" : { - "description" : "The physical store, for which this payment is processed.", - "type" : "string" - }, - "storePaymentMethod" : { - "x-addedInVersion" : 50, - "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", - "type" : "boolean" - }, - "url" : { - "description" : "The URL at which the shopper can complete the payment.", - "readOnly" : true, - "type" : "string" - } - }, - "required" : [ - "amount", - "reference", - "merchantAccount", - "id", - "url", - "status" - ] - }, - "PaymentMethod" : { - "properties" : { - "brand" : { - "x-addedInVersion" : 65, - "description" : "Brand for the selected gift card. For example: plastix, hmclub.", - "type" : "string" - }, - "brands" : { - "x-addedInVersion" : 49, - "description" : "List of possible brands. For example: visa, mc.", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "configuration" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "The configuration of the payment method.", - "type" : "object" - }, - "details" : { - "description" : "All input details to be provided to complete the payment with this payment method.", - "items" : { - "$ref" : "#/components/schemas/InputDetail" - }, - "type" : "array" - }, - "fundingSource" : { - "x-addedInVersion" : 53, - "description" : "The funding source of the payment method.", - "enum" : [ - "debit" - ], - "type" : "string" - }, - "group" : { - "description" : "The group where this payment method belongs to.", - "$ref" : "#/components/schemas/PaymentMethodGroup" - }, - "inputDetails" : { - "deprecated" : true, - "description" : "All input details to be provided to complete the payment with this payment method.", - "items" : { - "$ref" : "#/components/schemas/InputDetail" - }, - "type" : "array" - }, - "name" : { - "description" : "The displayable name of this payment method.", - "type" : "string" - }, - "type" : { - "description" : "The unique payment method code.", - "type" : "string" - } - } - }, - "PaymentMethodGroup" : { - "properties" : { - "name" : { - "description" : "The name of the group.", - "type" : "string" - }, - "paymentMethodData" : { - "description" : "Echo data to be used if the payment method is displayed as part of this group.", - "type" : "string" - }, - "type" : { - "description" : "The unique code of the group.", - "type" : "string" - } - } - }, - "PaymentMethodsRequest" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "x-anyOf" : [ - { - "$ref" : "#/components/schemas/AdditionalData3DSecure" - }, - { - "$ref" : "#/components/schemas/AdditionalDataAirline" - }, - { - "$ref" : "#/components/schemas/AdditionalDataCarRental" - }, - { - "$ref" : "#/components/schemas/AdditionalDataCommon" - }, - { - "$ref" : "#/components/schemas/AdditionalDataLevel23" - }, - { - "$ref" : "#/components/schemas/AdditionalDataLodging" - }, - { - "$ref" : "#/components/schemas/AdditionalDataOpenInvoice" - }, - { - "$ref" : "#/components/schemas/AdditionalDataOpi" - }, - { - "$ref" : "#/components/schemas/AdditionalDataRatepay" - }, - { - "$ref" : "#/components/schemas/AdditionalDataRetry" - }, - { - "$ref" : "#/components/schemas/AdditionalDataRisk" - }, - { - "$ref" : "#/components/schemas/AdditionalDataRiskStandalone" - }, - { - "$ref" : "#/components/schemas/AdditionalDataSubMerchant" - }, - { - "$ref" : "#/components/schemas/AdditionalDataTemporaryServices" - }, - { - "$ref" : "#/components/schemas/AdditionalDataWallets" - } - ], - "description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.", - "type" : "object" - }, - "allowedPaymentMethods" : { - "x-addedInVersion" : 33, - "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "amount" : { - "description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).", - "$ref" : "#/components/schemas/Amount" - }, - "blockedPaymentMethods" : { - "x-addedInVersion" : 33, - "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", - "items" : { - "type" : "string" - }, - "type" : "array" - }, - "channel" : { - "description" : "The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values:\n* iOS\n* Android\n* Web", - "enum" : [ - "iOS", - "Android", - "Web" - ], - "type" : "string" - }, - "countryCode" : { - "description" : "The shopper's country code.", - "type" : "string" - }, - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "order" : { - "x-addedInVersion" : 64, - "description" : "Contains the order information which is required for partial payments.", - "$ref" : "#/components/schemas/CheckoutOrder" - }, - "shopperLocale" : { - "x-addedInVersion" : 7, - "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", - "type" : "string" - }, - "shopperReference" : { - "description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.", - "type" : "string" - }, - "splitCardFundingSources" : { - "x-addedInVersion" : 53, - "default" : false, - "description" : "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", - "type" : "boolean" - }, - "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", - "maxLength" : 16, - "minLength" : 1, - "type" : "string" - } - }, - "required" : [ - "merchantAccount" - ] - }, - "PaymentMethodsResponse" : { - "properties" : { - "paymentMethods" : { - "description" : "Detailed list of payment methods required to generate payment forms.", - "items" : { - "$ref" : "#/components/schemas/PaymentMethod" - }, - "type" : "array" - }, - "storedPaymentMethods" : { - "x-addedInVersion" : 49, - "description" : "List of all stored payment methods.", - "items" : { - "$ref" : "#/components/schemas/StoredPaymentMethod" - }, - "type" : "array" - } - } - }, - "PaymentRefundResource" : { - "properties" : { - "amount" : { - "description" : "The refund amount.", - "$ref" : "#/components/schemas/Amount" - }, - "merchantAccount" : { - "description" : "The merchant account that is used to process the payment.", - "type" : "string" - }, - "paymentPspReference" : { - "description" : "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund. ", - "type" : "string" - }, - "pspReference" : { - "description" : "Adyen's 16-character reference associated with the refund request.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the refund request.", - "type" : "string" - }, - "splits" : { - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", - "items" : { - "$ref" : "#/components/schemas/Split" - }, - "type" : "array" - }, - "status" : { - "description" : "The status of your request. This will always have the value **received**.", - "enum" : [ - "received" - ], - "type" : "string" - } - }, - "required" : [ - "status", - "merchantAccount", - "amount", - "pspReference", - "paymentPspReference" - ] - }, - "PaymentRequest" : { + "PaymentDonationRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -7693,12 +7482,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -7707,7 +7496,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -7722,12 +7511,12 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -7736,7 +7525,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -7750,34 +7539,46 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, + "donationAccount" : { + "description" : "Donation account to which the transaction is credited.", + "type" : "string" + }, + "donationOriginalPspReference" : { + "description" : "PSP reference of the transaction from which the donation token is generated.", + "type" : "string" + }, + "donationToken" : { + "description" : "Donation token received in the `/payments` call.", + "type" : "string" + }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -7791,13 +7592,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -7808,7 +7609,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -7817,17 +7618,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -7847,7 +7648,7 @@ "type" : "string" }, "origin" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", "maxLength" : 8000, "type" : "string" @@ -7989,7 +7790,7 @@ "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -7999,12 +7800,12 @@ "type" : "string" }, "redirectFromIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", "type" : "string" }, "redirectToIssuerMethod" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", "type" : "string" }, @@ -8044,12 +7845,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8062,12 +7863,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8075,35 +7876,942 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", + "description" : "Set to true if the payment should be routed to a trusted MID.", + "type" : "boolean" + } + }, + "required" : [ + "merchantAccount", + "reference", + "amount", + "returnUrl", + "paymentMethod", + "donationAccount" + ] + }, + "PaymentLinkResource" : { + "properties" : { + "allowedPaymentMethods" : { + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "amount" : { + "description" : "The payment amount and currency.", + "$ref" : "#/components/schemas/Amount" + }, + "applicationInfo" : { + "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" + }, + "billingAddress" : { + "description" : "The address where to send the invoice.", + "$ref" : "#/components/schemas/Address" + }, + "blockedPaymentMethods" : { + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "countryCode" : { + "description" : "The shopper's two-letter country code.", + "type" : "string" + }, + "deliverAt" : { + "description" : "The date and time the purchased goods should be delivered. In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`.", + "format" : "date-time", + "type" : "string" + }, + "deliveryAddress" : { + "description" : "The address where the purchased goods should be delivered.", + "$ref" : "#/components/schemas/Address" + }, + "description" : { + "description" : "A short description visible on the payment page.\nMaximum length: 280 characters.", + "type" : "string" + }, + "expiresAt" : { + "description" : "The date that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 70 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created.", + "type" : "string" + }, + "id" : { + "x-addedInVersion" : "51", + "description" : "A unique identifier of the payment link.", + "readOnly" : true, + "type" : "string" + }, + "lineItems" : { + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.", + "items" : { + "$ref" : "#/components/schemas/LineItem" + }, + "type" : "array" + }, + "merchantAccount" : { + "description" : "The merchant account identifier for which the payment link is created.", + "type" : "string" + }, + "merchantOrderReference" : { + "description" : "This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.", + "type" : "string" + }, + "recurringProcessingModel" : { + "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", + "enum" : [ + "CardOnFile", + "Subscription", + "UnscheduledCardOnFile" + ], + "type" : "string" + }, + "reference" : { + "description" : "A reference that is used to uniquely identify the payment in future communications about the payment status.", + "type" : "string" + }, + "returnUrl" : { + "description" : "Website URL used for redirection after payment is completed.\nIf provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.", + "type" : "string" + }, + "reusable" : { + "description" : "Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.", + "type" : "boolean" + }, + "riskData" : { + "x-addedInVersion" : "65", + "description" : "Any risk-related settings to apply to the payment.", + "$ref" : "#/components/schemas/RiskData" + }, + "shopperEmail" : { + "description" : "The shopper's email address.", + "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).", + "type" : "string" + }, + "shopperName" : { + "description" : "The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.", + "$ref" : "#/components/schemas/Name" + }, + "shopperReference" : { + "description" : "A unique identifier for the shopper (for example, user ID or account ID).", + "type" : "string" + }, + "splits" : { + "description" : "An array of objects specifying how the payment should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", + "items" : { + "$ref" : "#/components/schemas/Split" + }, + "type" : "array" + }, + "status" : { + "description" : "Status of the payment link. Possible values:\n* **active** \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and below)", + "enum" : [ + "active", + "completed", + "expired", + "paymentPending" + ], + "type" : "string" + }, + "store" : { + "description" : "The physical store, for which this payment is processed.", + "type" : "string" + }, + "storePaymentMethod" : { + "x-addedInVersion" : "50", + "description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.", + "type" : "boolean" + }, + "url" : { + "description" : "The URL at which the shopper can complete the payment.", + "readOnly" : true, + "type" : "string" + } + }, + "required" : [ + "amount", + "reference", + "merchantAccount", + "id", + "url", + "status" + ] + }, + "PaymentMethod" : { + "properties" : { + "brand" : { + "x-addedInVersion" : "65", + "description" : "Brand for the selected gift card. For example: plastix, hmclub.", + "type" : "string" + }, + "brands" : { + "x-addedInVersion" : "49", + "description" : "List of possible brands. For example: visa, mc.", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "configuration" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "The configuration of the payment method.", + "type" : "object" + }, + "details" : { + "description" : "All input details to be provided to complete the payment with this payment method.", + "items" : { + "$ref" : "#/components/schemas/InputDetail" + }, + "type" : "array" + }, + "fundingSource" : { + "x-addedInVersion" : "53", + "description" : "The funding source of the payment method.", + "enum" : [ + "debit" + ], + "type" : "string" + }, + "group" : { + "description" : "The group where this payment method belongs to.", + "$ref" : "#/components/schemas/PaymentMethodGroup" + }, + "inputDetails" : { + "deprecated" : true, + "description" : "All input details to be provided to complete the payment with this payment method.", + "items" : { + "$ref" : "#/components/schemas/InputDetail" + }, + "type" : "array" + }, + "name" : { + "description" : "The displayable name of this payment method.", + "type" : "string" + }, + "type" : { + "description" : "The unique payment method code.", + "type" : "string" + } + } + }, + "PaymentMethodGroup" : { + "properties" : { + "name" : { + "description" : "The name of the group.", + "type" : "string" + }, + "paymentMethodData" : { + "description" : "Echo data to be used if the payment method is displayed as part of this group.", + "type" : "string" + }, + "type" : { + "description" : "The unique code of the group.", + "type" : "string" + } + } + }, + "PaymentMethodsRequest" : { + "properties" : { + "additionalData" : { + "additionalProperties" : { + "type" : "string" + }, + "x-anyOf" : [ + { + "$ref" : "#/components/schemas/AdditionalData3DSecure" + }, + { + "$ref" : "#/components/schemas/AdditionalDataAirline" + }, + { + "$ref" : "#/components/schemas/AdditionalDataCarRental" + }, + { + "$ref" : "#/components/schemas/AdditionalDataCommon" + }, + { + "$ref" : "#/components/schemas/AdditionalDataLevel23" + }, + { + "$ref" : "#/components/schemas/AdditionalDataLodging" + }, + { + "$ref" : "#/components/schemas/AdditionalDataOpenInvoice" + }, + { + "$ref" : "#/components/schemas/AdditionalDataOpi" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRatepay" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRetry" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRisk" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRiskStandalone" + }, + { + "$ref" : "#/components/schemas/AdditionalDataSubMerchant" + }, + { + "$ref" : "#/components/schemas/AdditionalDataTemporaryServices" + }, + { + "$ref" : "#/components/schemas/AdditionalDataWallets" + } + ], + "description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.", + "type" : "object" + }, + "allowedPaymentMethods" : { + "x-addedInVersion" : "33", + "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "amount" : { + "description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).", + "$ref" : "#/components/schemas/Amount" + }, + "blockedPaymentMethods" : { + "x-addedInVersion" : "33", + "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "channel" : { + "description" : "The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values:\n* iOS\n* Android\n* Web", + "enum" : [ + "iOS", + "Android", + "Web" + ], + "type" : "string" + }, + "countryCode" : { + "description" : "The shopper's country code.", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account identifier, with which you want to process the transaction.", + "type" : "string" + }, + "order" : { + "x-addedInVersion" : "64", + "description" : "Contains the order information which is required for partial payments.", + "$ref" : "#/components/schemas/CheckoutOrder" + }, + "shopperLocale" : { + "x-addedInVersion" : "7", + "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", + "type" : "string" + }, + "shopperReference" : { + "description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.", + "type" : "string" + }, + "splitCardFundingSources" : { + "x-addedInVersion" : "53", + "default" : false, + "description" : "Boolean value indicating whether the card payment method should be split into separate debit and credit options.", + "type" : "boolean" + }, + "store" : { + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", + "maxLength" : 16, + "minLength" : 1, + "type" : "string" + } + }, + "required" : [ + "merchantAccount" + ] + }, + "PaymentMethodsResponse" : { + "properties" : { + "paymentMethods" : { + "description" : "Detailed list of payment methods required to generate payment forms.", + "items" : { + "$ref" : "#/components/schemas/PaymentMethod" + }, + "type" : "array" + }, + "storedPaymentMethods" : { + "x-addedInVersion" : "49", + "description" : "List of all stored payment methods.", + "items" : { + "$ref" : "#/components/schemas/StoredPaymentMethod" + }, + "type" : "array" + } + } + }, + "PaymentRefundResource" : { + "properties" : { + "amount" : { + "description" : "The refund amount.", + "$ref" : "#/components/schemas/Amount" + }, + "merchantAccount" : { + "description" : "The merchant account that is used to process the payment.", + "type" : "string" + }, + "paymentPspReference" : { + "description" : "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund. ", + "type" : "string" + }, + "pspReference" : { + "description" : "Adyen's 16-character reference associated with the refund request.", + "type" : "string" + }, + "reference" : { + "description" : "Your reference for the refund request.", + "type" : "string" + }, + "splits" : { + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", + "items" : { + "$ref" : "#/components/schemas/Split" + }, + "type" : "array" + }, + "status" : { + "description" : "The status of your request. This will always have the value **received**.", + "enum" : [ + "received" + ], + "type" : "string" + } + }, + "required" : [ + "status", + "merchantAccount", + "amount", + "pspReference", + "paymentPspReference" + ] + }, + "PaymentRequest" : { + "properties" : { + "accountInfo" : { + "x-addedInVersion" : "40", + "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", + "$ref" : "#/components/schemas/AccountInfo" + }, + "additionalData" : { + "additionalProperties" : { + "type" : "string" + }, + "x-anyOf" : [ + { + "$ref" : "#/components/schemas/AdditionalData3DSecure" + }, + { + "$ref" : "#/components/schemas/AdditionalDataAirline" + }, + { + "$ref" : "#/components/schemas/AdditionalDataCarRental" + }, + { + "$ref" : "#/components/schemas/AdditionalDataCommon" + }, + { + "$ref" : "#/components/schemas/AdditionalDataLevel23" + }, + { + "$ref" : "#/components/schemas/AdditionalDataLodging" + }, + { + "$ref" : "#/components/schemas/AdditionalDataOpenInvoice" + }, + { + "$ref" : "#/components/schemas/AdditionalDataOpi" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRatepay" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRetry" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRisk" + }, + { + "$ref" : "#/components/schemas/AdditionalDataRiskStandalone" + }, + { + "$ref" : "#/components/schemas/AdditionalDataSubMerchant" + }, + { + "$ref" : "#/components/schemas/AdditionalDataTemporaryServices" + }, + { + "$ref" : "#/components/schemas/AdditionalDataWallets" + } + ], + "description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.", + "type" : "object" + }, + "amount" : { + "description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).", + "$ref" : "#/components/schemas/Amount" + }, + "applicationInfo" : { + "x-addedInVersion" : "40", + "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" + }, + "billingAddress" : { + "x-addedInVersion" : "4", + "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", + "$ref" : "#/components/schemas/Address" + }, + "browserInfo" : { + "description" : "The shopper's browser information.\n> For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.", + "$ref" : "#/components/schemas/BrowserInfo" + }, + "captureDelayHours" : { + "x-addedInVersion" : "2", + "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", + "format" : "int32", + "type" : "integer" + }, + "channel" : { + "description" : "The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`.\n\nPossible values:\n* iOS\n* Android\n* Web", + "enum" : [ + "iOS", + "Android", + "Web" + ], + "type" : "string" + }, + "company" : { + "x-addedInVersion" : "32", + "description" : "Information regarding the company.", + "$ref" : "#/components/schemas/Company" + }, + "conversionId" : { + "x-addedInVersion" : "49", + "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", + "type" : "string" + }, + "countryCode" : { + "description" : "The shopper country.\n\nFormat: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\nExample: NL or DE", + "type" : "string" + }, + "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", + "type" : "string" + }, + "dccQuote" : { + "description" : "The forex quote as returned in the response of the forex service.", + "$ref" : "#/components/schemas/ForexQuote" + }, + "deliveryAddress" : { + "description" : "The address where the purchased goods should be delivered.", + "$ref" : "#/components/schemas/Address" + }, + "deliveryDate" : { + "x-addedInVersion" : "8", + "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", + "format" : "date-time", + "type" : "string" + }, + "deviceFingerprint" : { + "x-addedInVersion" : "2", + "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", + "maxLength" : 5000, + "type" : "string" + }, + "enableOneClick" : { + "x-addedInVersion" : "32", + "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", + "type" : "boolean" + }, + "enablePayOut" : { + "x-addedInVersion" : "32", + "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", + "type" : "boolean" + }, + "enableRecurring" : { + "x-addedInVersion" : "32", + "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", + "type" : "boolean" + }, + "entityType" : { + "x-addedInVersion" : "24", + "description" : "The type of the entity the payment is processed for.", + "enum" : [ + "NaturalPerson", + "CompanyName" + ], + "type" : "string" + }, + "fraudOffset" : { + "description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.", + "format" : "int32", + "type" : "integer" + }, + "installments" : { + "x-addedInVersion" : "4", + "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", + "$ref" : "#/components/schemas/Installments" + }, + "lineItems" : { + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", + "items" : { + "$ref" : "#/components/schemas/LineItem" + }, + "type" : "array" + }, + "mandate" : { + "description" : "The mandate details to initiate recurring transaction.", + "$ref" : "#/components/schemas/Mandate" + }, + "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.", + "type" : "string" + }, + "merchantAccount" : { + "description" : "The merchant account identifier, with which you want to process the transaction.", + "type" : "string" + }, + "merchantOrderReference" : { + "x-addedInVersion" : "9", + "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", + "type" : "string" + }, + "merchantRiskIndicator" : { + "x-addedInVersion" : "40", + "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", + "$ref" : "#/components/schemas/MerchantRiskIndicator" + }, + "metadata" : { + "x-addedInVersion" : "17", + "additionalProperties" : { + "type" : "string" + }, + "description" : "Metadata consists of entries, each of which includes a key and a value.\nLimits:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\".\n* Maximum 20 characters per key.\n* Maximum 80 characters per value. ", + "type" : "object" + }, + "mpiData" : { + "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", + "$ref" : "#/components/schemas/ThreeDSecureData" + }, + "order" : { + "description" : "Contains the order information which is required for partial payments.", + "$ref" : "#/components/schemas/CheckoutOrder" + }, + "orderReference" : { + "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" + }, + "origin" : { + "x-addedInVersion" : "40", + "description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.", + "maxLength" : 8000, + "type" : "string" + }, + "paymentMethod" : { + "description" : "The type and required details of a payment method to use.", + "oneOf" : [ + { + "$ref" : "#/components/schemas/AchDetails" + }, + { + "$ref" : "#/components/schemas/AfterpayDetails" + }, + { + "$ref" : "#/components/schemas/AmazonPayDetails" + }, + { + "$ref" : "#/components/schemas/AndroidPayDetails" + }, + { + "$ref" : "#/components/schemas/ApplePayDetails" + }, + { + "$ref" : "#/components/schemas/BacsDirectDebitDetails" + }, + { + "$ref" : "#/components/schemas/BillDeskDetails" + }, + { + "$ref" : "#/components/schemas/BlikDetails" + }, + { + "$ref" : "#/components/schemas/CardDetails" + }, + { + "$ref" : "#/components/schemas/CellulantDetails" + }, + { + "$ref" : "#/components/schemas/DokuDetails" + }, + { + "$ref" : "#/components/schemas/DotpayDetails" + }, + { + "$ref" : "#/components/schemas/DragonpayDetails" + }, + { + "$ref" : "#/components/schemas/EcontextVoucherDetails" + }, + { + "$ref" : "#/components/schemas/EntercashDetails" + }, + { + "$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails" + }, + { + "$ref" : "#/components/schemas/GiropayDetails" + }, + { + "$ref" : "#/components/schemas/GooglePayDetails" + }, + { + "$ref" : "#/components/schemas/IdealDetails" + }, + { + "$ref" : "#/components/schemas/KlarnaDetails" + }, + { + "$ref" : "#/components/schemas/LianLianPayDetails" + }, + { + "$ref" : "#/components/schemas/MasterpassDetails" + }, + { + "$ref" : "#/components/schemas/MbwayDetails" + }, + { + "$ref" : "#/components/schemas/MobilePayDetails" + }, + { + "$ref" : "#/components/schemas/MolPayDetails" + }, + { + "$ref" : "#/components/schemas/OpenInvoiceDetails" + }, + { + "$ref" : "#/components/schemas/PayPalDetails" + }, + { + "$ref" : "#/components/schemas/PayUUpiDetails" + }, + { + "$ref" : "#/components/schemas/PayWithGoogleDetails" + }, + { + "$ref" : "#/components/schemas/PaymentDetails" + }, + { + "$ref" : "#/components/schemas/QiwiWalletDetails" + }, + { + "$ref" : "#/components/schemas/RatepayDetails" + }, + { + "$ref" : "#/components/schemas/SamsungPayDetails" + }, + { + "$ref" : "#/components/schemas/SepaDirectDebitDetails" + }, + { + "$ref" : "#/components/schemas/StoredPaymentMethodDetails" + }, + { + "$ref" : "#/components/schemas/UpiDetails" + }, + { + "$ref" : "#/components/schemas/VippsDetails" + }, + { + "$ref" : "#/components/schemas/VisaCheckoutDetails" + }, + { + "$ref" : "#/components/schemas/WeChatPayDetails" + }, + { + "$ref" : "#/components/schemas/WeChatPayMiniProgramDetails" + }, + { + "$ref" : "#/components/schemas/ZipDetails" + } + ] + }, + "recurringExpiry" : { + "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", + "type" : "string" + }, + "recurringFrequency" : { + "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", + "type" : "string" + }, + "recurringProcessingModel" : { + "x-addedInVersion" : "30", + "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", + "enum" : [ + "CardOnFile", + "Subscription", + "UnscheduledCardOnFile" + ], + "type" : "string" + }, + "redirectFromIssuerMethod" : { + "x-addedInVersion" : "32", + "description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.", + "type" : "string" + }, + "redirectToIssuerMethod" : { + "x-addedInVersion" : "32", + "description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.", + "type" : "string" + }, + "reference" : { + "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", + "type" : "string" + }, + "returnUrl" : { + "description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`", + "maxLength" : 8000, + "type" : "string" + }, + "riskData" : { + "description" : "Contains risk data, such as client-side data, used to identify risk for a transaction.", + "$ref" : "#/components/schemas/RiskData" + }, + "sessionValidity" : { + "description" : "The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.\n\nFor example: 2020-07-18T15:42:40.428+01:00", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.", + "type" : "string" + }, + "shopperIP" : { + "description" : "The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).\n> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.\nThis field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).", + "type" : "string" + }, + "shopperInteraction" : { + "description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", + "enum" : [ + "Ecommerce", + "ContAuth", + "Moto", + "POS" + ], + "type" : "string" + }, + "shopperLocale" : { + "x-addedInVersion" : "7", + "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", + "type" : "string" + }, + "shopperName" : { + "x-addedInVersion" : "7", + "description" : "The shopper's full name.", + "$ref" : "#/components/schemas/Name" + }, + "shopperReference" : { + "description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.", + "type" : "string" + }, + "shopperStatement" : { + "description" : "The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.", + "type" : "string" + }, + "socialSecurityNumber" : { + "x-addedInVersion" : "4", + "description" : "The shopper's social security number.", + "type" : "string" + }, + "splits" : { + "x-addedInVersion" : "37", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "items" : { + "$ref" : "#/components/schemas/Split" + }, + "type" : "array" + }, + "store" : { + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", + "maxLength" : 16, + "minLength" : 1, + "type" : "string" + }, + "storePaymentMethod" : { + "x-addedInVersion" : "49", + "description" : "When true and `shopperReference` is provided, the payment details will be stored.", + "type" : "boolean" + }, + "telephoneNumber" : { + "x-addedInVersion" : "7", + "description" : "The shopper's telephone number.", + "type" : "string" + }, + "threeDS2RequestData" : { + "x-addedInVersion" : "40", + "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", + "$ref" : "#/components/schemas/ThreeDS2RequestData" + }, + "threeDSAuthenticationOnly" : { + "x-addedInVersion" : "50", + "default" : false, + "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.", + "type" : "boolean" + }, + "trustedShopper" : { + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8119,7 +8827,7 @@ "PaymentResponse" : { "properties" : { "action" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Action to be taken for completing the payment.", "oneOf" : [ { @@ -8191,12 +8899,12 @@ "type" : "object" }, "amount" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "Authorised amount in the transaction.", "$ref" : "#/components/schemas/Amount" }, "donationToken" : { - "x-addedInVersion" : 66, + "x-addedInVersion" : "66", "description" : "Donation Token containing payment details for Adyen Giving.", "type" : "string" }, @@ -8205,7 +8913,7 @@ "$ref" : "#/components/schemas/FraudResult" }, "merchantReference" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.", "type" : "string" }, @@ -8222,7 +8930,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8245,17 +8953,17 @@ "type" : "string" }, "threeDS2ResponseData" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "Response of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2ResponseData" }, "threeDS2Result" : { - "x-addedInVersion" : 41, + "x-addedInVersion" : "41", "description" : "Result of the 3D Secure 2 authentication.", "$ref" : "#/components/schemas/ThreeDS2Result" }, "threeDSPaymentData" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.", "type" : "string" } @@ -8351,7 +9059,7 @@ "type" : "object" }, "allowedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8363,17 +9071,17 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, "blockedPaymentMethods" : { - "x-addedInVersion" : 33, + "x-addedInVersion" : "33", "description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`", "items" : { "type" : "string" @@ -8381,7 +9089,7 @@ "type" : "array" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -8396,7 +9104,7 @@ "type" : "string" }, "company" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "Information regarding the company.", "$ref" : "#/components/schemas/Company" }, @@ -8405,7 +9113,7 @@ "$ref" : "#/components/schemas/Configuration" }, "conversionId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.", "type" : "string" }, @@ -8414,7 +9122,7 @@ "type" : "string" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -8428,28 +9136,28 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "enableOneClick" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.", "type" : "boolean" }, "enablePayOut" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.", "type" : "boolean" }, "enableRecurring" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -8463,13 +9171,13 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "lineItems" : { - "x-addedInVersion" : 32, - "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.", + "x-addedInVersion" : "32", + "description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.", "items" : { "$ref" : "#/components/schemas/LineItem" }, @@ -8480,7 +9188,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -8489,12 +9197,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -8531,7 +9239,7 @@ "$ref" : "#/components/schemas/RiskData" }, "sdkVersion" : { - "x-addedInVersion" : 32, + "x-addedInVersion" : "32", "description" : "The version of the SDK you are using (for Web SDK integrations only).", "type" : "string" }, @@ -8558,12 +9266,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -8576,12 +9284,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -8589,24 +9297,24 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "storePaymentMethod" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "When true and `shopperReference` is provided, the payment details will be stored.", "type" : "boolean" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" @@ -8616,7 +9324,7 @@ "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -8723,7 +9431,7 @@ "type" : "string" }, "refusalReasonCode" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).", "type" : "string" }, @@ -8798,13 +9506,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -8838,18 +9546,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -8862,12 +9570,12 @@ "RecurringDetail" : { "properties" : { "brand" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "Brand for the selected gift card. For example: plastix, hmclub.", "type" : "string" }, "brands" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "List of possible brands. For example: visa, mc.", "items" : { "type" : "string" @@ -8889,7 +9597,7 @@ "type" : "array" }, "fundingSource" : { - "x-addedInVersion" : 53, + "x-addedInVersion" : "53", "description" : "The funding source of the payment method.", "enum" : [ "debit" @@ -8966,6 +9674,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -9157,6 +9869,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -9194,7 +9917,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -9207,12 +9930,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -9422,7 +10145,7 @@ "type" : "string" }, "customFields" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "additionalProperties" : { "type" : "string" }, @@ -9430,13 +10153,13 @@ "type" : "object" }, "fraudOffset" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.", "format" : "int32", "type" : "integer" }, "profileReference" : { - "x-addedInVersion" : 65, + "x-addedInVersion" : "65", "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" } @@ -9474,7 +10197,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -9484,7 +10207,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9515,13 +10238,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9543,7 +10266,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -9756,7 +10479,7 @@ "type" : "string" }, "iban" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "The IBAN of the bank account.", "type" : "string" }, @@ -9773,7 +10496,7 @@ "type" : "string" }, "ownerName" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "The name of the bank account holder.", "type" : "string" }, @@ -9799,13 +10522,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -9823,7 +10546,6 @@ "grabpay_TH", "grabpay_ID", "grabpay_VN", - "grabpay_VN", "grabpay_PH", "oxxo", "gcash", @@ -9872,18 +10594,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -9908,12 +10630,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -9953,7 +10675,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -9974,7 +10696,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -9986,7 +10708,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -10063,17 +10785,17 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, "challengeCancel" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "description" : "Indicator informing the ACS and the DS that the authentication has been canceled.", "type" : "string" }, "challengeIndicator" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "type" : "string" }, "dsTransID" : { @@ -10085,16 +10807,16 @@ "type" : "string" }, "exemptionIndicator" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, "riskScore" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "type" : "string" }, "threeDSServerTransID" : { @@ -10114,7 +10836,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -10142,7 +10864,7 @@ "type" : "string" }, "challengeCancel" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "type" : "string" }, "directoryResponse" : { @@ -10160,7 +10882,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -10169,16 +10891,16 @@ "type" : "string" }, "riskScore" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, "transStatusReason" : { - "x-addedInVersion" : 67, + "x-addedInVersion" : "67", "type" : "string" }, "xid" : { @@ -10211,7 +10933,7 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" @@ -10221,7 +10943,7 @@ "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10249,13 +10971,13 @@ "properties" : { "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10348,13 +11070,13 @@ }, "recurringDetailReference" : { "deprecated" : true, - "x-deprecatedInVersion" : 49, + "x-deprecatedInVersion" : "49", "x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, "storedPaymentMethodId" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "This is the `recurringDetailReference` returned in the response when you created the token.", "type" : "string" }, @@ -10401,16 +11123,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -10419,37 +11132,7 @@ "errorType" : "security" } }, - "generic-403" : { - "summary" : "Response code 403. Forbidden.", - "value" : { - "status" : 403, - "errorCode" : "901", - "message" : "Invalid Merchant Account", - "errorType" : "security", - "pspReference" : "881611827877203B" - } - }, - "generic-422" : { - "summary" : "Response code 422. Unprocessable entity.", - "value" : { - "status" : 422, - "errorCode" : "14_030", - "message" : "Return URL is missing.", - "errorType" : "validation", - "pspReference" : "8816118280275544" - } - }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, - "get-paymentLinks-linkId-basic-200" : { + "get-paymentLinks-linkId-basic" : { "summary" : "Example response for request 'basic'", "value" : { "amount" : { @@ -10472,21 +11155,24 @@ "status" : "expired" } }, - "patch-paymentLinks-linkId-basic-200" : { - "summary" : "Example response for request 'basic'", + "post-donations-donations" : { + "summary" : "Start a transaction for donation", "value" : { "amount" : { "currency" : "EUR", - "value" : 8700 + "value" : 1000 }, - "countryCode" : "NL", - "expiresAt" : "2021-04-08T14:06:39Z", - "merchantAccount" : "TestMerchantCheckout", - "reference" : "shopper-reference-ekvL83", - "shopperLocale" : "hu-HU", - "shopperReference" : "shopper-reference-LZfdWZ", - "status" : "expired", - "url" : "https://test.adyen.link/PL61C53A8B97E6915A" + "reference" : "YOUR_DONATION_REFERENCE", + "paymentMethod" : { + "type" : "scheme", + "cvc" : "123" + }, + "donationToken" : "YOUR_DONATION_TOKEN", + "donationOriginalPspReference" : "991559660454807J", + "donationAccount" : "CHARITY_ACCOUNT", + "returnUrl" : "https://your-company.com/...", + "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", + "shopperInteraction" : "Ecommerce" } }, "post-orders-basic" : { @@ -10500,20 +11186,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178914061985", - "resultCode" : "Success", - "expiresAt" : "2021-04-09T14:16:46Z", - "orderData" : "Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==", - "reference" : "shopper-reference-ekvL83", - "remainingAmount" : { - "currency" : "EUR", - "value" : 2500 - } - } - }, "post-orders-cancel-basic" : { "summary" : "Cancel an order", "value" : { @@ -10524,13 +11196,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-orders-cancel-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8816178914079738", - "resultCode" : "Received" - } - }, "post-originKeys-basic" : { "summary" : "Get origin keys", "value" : { @@ -10541,16 +11206,6 @@ ] } }, - "post-originKeys-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "originKeys" : { - "https://www.your-domain1.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw", - "https://www.your-domain3.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc", - "https://www.your-domain2.com" : "pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg" - } - } - }, "post-paymentLinks-basic" : { "summary" : "Create a payment link", "value" : { @@ -10582,18 +11237,6 @@ } } }, - "post-paymentLinks-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 1250 - }, - "expiresAt" : "2021-04-09T14:17:31Z", - "reference" : "shopper-reference-ekvL83", - "url" : "https://test.adyen.link/PL6DB3157D27FFBBCF" - } - }, "post-paymentMethods-balance-basic" : { "summary" : "Retrieve gift card balance", "value" : { @@ -10617,2919 +11260,13 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-balance-plastix-200" : { - "summary" : "Example response for request 'plastix'", - "value" : { - "additionalData" : { - "nonScheme.transactionLimit" : "5000", - "nonScheme.transactionLimitCcy" : "EUR" - }, - "pspReference" : "851617891188737F", - "resultCode" : "Success", - "balance" : { - "currency" : "EUR", - "value" : 888 - } - } - }, "post-paymentMethods-basic" : { "summary" : "Get available payment methods", "value" : { "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-paymentMethods-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "details" : [ - { - "key" : "ownerName", - "type" : "text" - }, - { - "key" : "bankLocationId", - "type" : "text" - }, - { - "key" : "bankAccountNumber", - "type" : "text" - } - ], - "key" : "bankAccount", - "type" : "bankAccount" - } - ], - "name" : "ACH Direct Debit", - "type" : "ach" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "Afterpay", - "type" : "afterpaytouch" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay HK", - "type" : "alipay_hk" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Credit Card via AsiaPay", - "type" : "asiapay" - }, - { - "name" : "China UnionPay", - "type" : "asiapay_unionpay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "Baloto", - "type" : "baloto" - }, - { - "name" : "BancNet", - "type" : "bancnet" - }, - { - "name" : "Bank Transfer (BG)", - "type" : "bankTransfer_BG" - }, - { - "name" : "Bank Transfer (CH)", - "type" : "bankTransfer_CH" - }, - { - "name" : "Bank Transfer (DE)", - "type" : "bankTransfer_DE" - }, - { - "name" : "Bank Transfer (FI)", - "type" : "bankTransfer_FI" - }, - { - "name" : "Bank Transfer (GB)", - "type" : "bankTransfer_GB" - }, - { - "name" : "Bank Transfer (HU)", - "type" : "bankTransfer_HU" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bank Transfer (IE)", - "type" : "bankTransfer_IE" - }, - { - "name" : "Electronic Bank Transfer (MX)", - "type" : "bankTransfer_MX_linked" - }, - { - "name" : "Bank Transfer (MX)", - "type" : "bankTransfer_MX_offline" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Bank Transfer (PL)", - "type" : "bankTransfer_PL" - }, - { - "name" : "Bank Transfer (SE)", - "type" : "bankTransfer_SE" - }, - { - "name" : "Bank Transfer (US)", - "type" : "bankTransfer_US" - }, - { - "name" : "Payconiq by Bancontact", - "type" : "bcmc_mobile" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "99Bill", - "type" : "bill99" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "AUB_DIRECT", - "name" : "AU Small Finance Bank" - }, - { - "id" : "ALB_DIRECT", - "name" : "Allahabad Bank " - }, - { - "id" : "APG_DIRECT", - "name" : "Andhra Pragathi Grameena Bank" - }, - { - "id" : "BDN_DIRECT", - "name" : "Bandhan bank" - }, - { - "id" : "BBK_DIRECT", - "name" : "Bank of Bahrain and Kuwait" - }, - { - "id" : "BBR_DIRECT", - "name" : "Bank of Baroda - Retail Banking" - }, - { - "id" : "BCB_DIRECT", - "name" : "Bassien Catholic Co-Operative Bank " - }, - { - "id" : "CNB_DIRECT", - "name" : "Canara Bank" - }, - { - "id" : "SYD_DIRECT", - "name" : "Canara Bank (e-Syndicate)" - }, - { - "id" : "CSB_DIRECT", - "name" : "Catholic Syrian Bank" - }, - { - "id" : "CBI_DIRECT", - "name" : "Central Bank of India" - }, - { - "id" : "CUB_DIRECT", - "name" : "City Union Bank" - }, - { - "id" : "COB_DIRECT", - "name" : "Cosmos Bank" - }, - { - "id" : "DEN_DIRECT", - "name" : "Dena Bank" - }, - { - "id" : "DBK_DIRECT", - "name" : "Deutsche Bank" - }, - { - "id" : "DCB_DIRECT", - "name" : "Development Credit Bank" - }, - { - "id" : "DLB_DIRECT", - "name" : "Dhanlakshmi Bank - Retail Net Banking" - }, - { - "id" : "ESF_DIRECT", - "name" : "ESAF Small Finance Bank" - }, - { - "id" : "EQB_DIRECT", - "name" : "Equitas Small Finance Bank" - }, - { - "id" : "FBK_DIRECT", - "name" : "Federal Bank" - }, - { - "id" : "FNC_DIRECT", - "name" : "Fincare Bank" - }, - { - "id" : "HDF_DIRECT", - "name" : "HDFC Bank" - }, - { - "id" : "ICI_DIRECT", - "name" : "ICICI Bank " - }, - { - "id" : "IDB_DIRECT", - "name" : "IDBI Bank - Retail Net Banking" - }, - { - "id" : "IDN_DIRECT", - "name" : "IDFC FIRST Bank" - }, - { - "id" : "INB_DIRECT", - "name" : "Indian Bank" - }, - { - "id" : "IOB_DIRECT", - "name" : "Indian Overseas Bank" - }, - { - "id" : "IDS_DIRECT", - "name" : "IndusInd Bank" - }, - { - "id" : "JKB_DIRECT", - "name" : "Jammu & Kashmir Bank" - }, - { - "id" : "JNB_DIRECT", - "name" : "Jana Small Finance Bank" - }, - { - "id" : "JSB_DIRECT", - "name" : "Janata Sahakari Bank Ltd Pune" - }, - { - "id" : "KJB_DIRECT", - "name" : "Kalyan Janata Sahakari Bank" - }, - { - "id" : "KBL_DIRECT", - "name" : "Karnataka Bank Ltd" - }, - { - "id" : "KVB_DIRECT", - "name" : "Karur Vysya Bank" - }, - { - "id" : "162_DIRECT", - "name" : "Kotak Bank" - }, - { - "id" : "LVR_DIRECT", - "name" : "Laxmi Vilas Bank - Retail" - }, - { - "id" : "NKB_DIRECT", - "name" : "NKGSB Co-op Bank" - }, - { - "id" : "NEB_DIRECT", - "name" : "North East Small Finance Bank" - }, - { - "id" : "OBC_DIRECT", - "name" : "PNB (Erstwhile-Oriental Bank of Commerce)" - }, - { - "id" : "UNI_DIRECT", - "name" : "PNB (Erstwhile-United Bank of India)" - }, - { - "id" : "PMC_DIRECT", - "name" : "Punjab & Maharastra Co-op Bank" - }, - { - "id" : "PSB_DIRECT", - "name" : "Punjab & Sind Bank" - }, - { - "id" : "CPN_DIRECT", - "name" : "Punjab National Bank - Corporate " - }, - { - "id" : "PNB_DIRECT", - "name" : "Punjab National Bank - Retail Banking" - }, - { - "id" : "RBL_DIRECT", - "name" : "RBL Bank Limited" - }, - { - "id" : "SWB_DIRECT", - "name" : "Saraswat Bank" - }, - { - "id" : "SHB_DIRECT", - "name" : "Shivalik Mercantile Cooperative Bank Ltd" - }, - { - "id" : "SIB_DIRECT", - "name" : "South Indian Bank" - }, - { - "id" : "SCB_DIRECT", - "name" : "Standard Chartered Bank" - }, - { - "id" : "SBI_DIRECT", - "name" : "State Bank of India" - }, - { - "id" : "SRB_DIRECT", - "name" : "Suryoday Small Finance Bank" - }, - { - "id" : "TJB_DIRECT", - "name" : "TJSB Bank" - }, - { - "id" : "TNC_DIRECT", - "name" : "Tamil Nadu State Co-operative Bank" - }, - { - "id" : "TMB_DIRECT", - "name" : "Tamilnad Mercantile Bank Ltd" - }, - { - "id" : "TBB_DIRECT", - "name" : "Thane Bharat Sahakari Bank Ltd" - }, - { - "id" : "MSB_DIRECT", - "name" : "The Mehsana Urban Co Op Bank Ltd" - }, - { - "id" : "UCO_DIRECT", - "name" : "UCO Bank" - }, - { - "id" : "UBI_DIRECT", - "name" : "Union Bank of India" - }, - { - "id" : "ADB_DIRECT", - "name" : "Union Bank of India (Erstwhile Andhra Bank)" - }, - { - "id" : "CRP_DIRECT", - "name" : "Union Bank of India (Erstwhile Corporation Bank)" - }, - { - "id" : "VRB_DIRECT", - "name" : "Varachha Co-operative Bank Limited" - }, - { - "id" : "VJB_DIRECT", - "name" : "Vijaya Bank" - }, - { - "id" : "YBK_DIRECT", - "name" : "Yes Bank" - }, - { - "id" : "ZOB_DIRECT", - "name" : "Zoroastrian Co-operative Bank Limited" - }, - { - "id" : "DBS_DIRECT", - "name" : "digibank by DBS" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online Banking India", - "type" : "billdesk_online" - }, - { - "name" : "UPI", - "type" : "billdesk_upi" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "DCW_DIRECT", - "name" : "DCB Cippy" - }, - { - "id" : "ICC_DIRECT", - "name" : "ICC Cash Card" - }, - { - "id" : "OXY_DIRECT", - "name" : "Oxigen Wallet" - }, - { - "id" : "PCH_DIRECT", - "name" : "Pay World Money" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Wallets India", - "type" : "billdesk_wallet" - }, - { - "name" : "Blik", - "type" : "blik" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Boleto", - "type" : "boleto" - }, - { - "name" : "Boleto Bancario", - "type" : "boletobancario_santander" - }, - { - "name" : "Bradesco", - "type" : "bradesco" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "CashU", - "type" : "cashu" - }, - { - "name" : "CCAvenue", - "type" : "ccavenue" - }, - { - "name" : "Mula Checkout", - "type" : "cellulant" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "Clearpay", - "type" : "clearpay" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Paiement en 3 fois par Cartes Bancaires", - "type" : "cofinoga_3xcb" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "DANA", - "type" : "dana" - }, - { - "name" : "DineroMail", - "type" : "dineromail" - }, - { - "name" : "Online bank transfer.", - "type" : "directEbanking" - }, - { - "name" : "Direct Debit Brazil - Banco do Brazil", - "type" : "directdebit_BR_bancodobrasil" - }, - { - "name" : "Direct Debit Brazil - Bradesco", - "type" : "directdebit_BR_bradesco" - }, - { - "name" : "Direct Debit Brazil - Caixa Economica Federal", - "type" : "directdebit_BR_caixa" - }, - { - "name" : "Direct Debit Brazil - HSBC", - "type" : "directdebit_BR_hsbc" - }, - { - "name" : "Direct Debit Brazil - Itau", - "type" : "directdebit_BR_itau" - }, - { - "name" : "Direct Debit Brazil - Santander", - "type" : "directdebit_BR_santander" - }, - { - "name" : "BACS Direct Debit", - "type" : "directdebit_GB" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Alfamart", - "type" : "doku_alfamart" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BCA Bank Transfer", - "type" : "doku_bca_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BNI VA", - "type" : "doku_bni_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "BRI VA", - "type" : "doku_bri_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "CIMB VA", - "type" : "doku_cimb_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Danamon VA", - "type" : "doku_danamon_va" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Indomaret", - "type" : "doku_indomaret" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Mandiri VA", - "type" : "doku_mandiri_va" - }, - { - "details" : [ - { - "key" : "ovoId", - "type" : "text" - } - ], - "name" : "OVO", - "type" : "doku_ovo" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "Bank Transfer", - "type" : "doku_permata_lite_atm" - }, - { - "details" : [ - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "key" : "infix", - "optional" : true, - "type" : "text" - } - ], - "name" : "DOKU wallet", - "type" : "doku_wallet" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "66", - "name" : "Bank Nowy BFG S.A." - }, - { - "id" : "92", - "name" : "Bank Spółdzielczy w Brodnicy" - }, - { - "id" : "11", - "name" : "Bank transfer / postal" - }, - { - "id" : "74", - "name" : "Banki Spółdzielcze" - }, - { - "id" : "73", - "name" : "BLIK" - }, - { - "id" : "90", - "name" : "BNP Paribas - płacę z Pl@net" - }, - { - "id" : "59", - "name" : "CinkciarzPAY" - }, - { - "id" : "87", - "name" : "Credit Agricole PBL" - }, - { - "id" : "83", - "name" : "EnveloBank" - }, - { - "id" : "76", - "name" : "Getin Bank PBL" - }, - { - "id" : "81", - "name" : "Idea Cloud" - }, - { - "id" : "7", - "name" : "ING Corporate customers" - }, - { - "id" : "93", - "name" : "Kasa Stefczyka" - }, - { - "id" : "44", - "name" : "Millennium - Płatności Internetowe" - }, - { - "id" : "10", - "name" : "Millennium Corporate customers" - }, - { - "id" : "68", - "name" : "mRaty" - }, - { - "id" : "1", - "name" : "mTransfer" - }, - { - "id" : "91", - "name" : "Nest Bank" - }, - { - "id" : "80", - "name" : "Noble Pay" - }, - { - "id" : "50", - "name" : "Pay Way Toyota Bank" - }, - { - "id" : "45", - "name" : "Pay with Alior Bank" - }, - { - "id" : "36", - "name" : "Pekao24Przelew" - }, - { - "id" : "70", - "name" : "Pocztowy24" - }, - { - "id" : "6", - "name" : "Przelew24" - }, - { - "id" : "46", - "name" : "Płacę z Citi Handlowy" - }, - { - "id" : "38", - "name" : "Płacę z ING" - }, - { - "id" : "2", - "name" : "Płacę z Inteligo" - }, - { - "id" : "4", - "name" : "Płacę z iPKO" - }, - { - "id" : "75", - "name" : "Płacę z Plus Bank" - }, - { - "id" : "51", - "name" : "Płać z BOŚ" - }, - { - "id" : "55", - "name" : "Raty z Alior Bankiem PLN" - }, - { - "id" : "89", - "name" : "Santander" - }, - { - "id" : "52", - "name" : "SkyCash" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Local Polish Payment Methods", - "type" : "dotpay" - }, - { - "name" : "Dragonpay Prepaid Credits", - "type" : "dragonpay_credits" - }, - { - "name" : "Online Banking", - "type" : "dragonpay_ebanking" - }, - { - "name" : "GCash", - "type" : "dragonpay_gcash" - }, - { - "name" : "Over The Counter Banks", - "type" : "dragonpay_otc_banking" - }, - { - "name" : "OTC non-Bank via Dragonpay", - "type" : "dragonpay_otc_non_banking" - }, - { - "name" : "Convenience Stores", - "type" : "dragonpay_otc_philippines" - }, - { - "name" : "7/11", - "type" : "dragonpay_seveneleven" - }, - { - "name" : "eagleeye_voucher", - "type" : "eagleeye_voucher" - }, - { - "name" : "Finnish E-Banking", - "type" : "ebanking_FI" - }, - { - "name" : "Pay-easy ATM", - "type" : "econtext_atm" - }, - { - "name" : "Online Banking", - "type" : "econtext_online" - }, - { - "name" : "7-Eleven", - "type" : "econtext_seven_eleven" - }, - { - "name" : "Convenience Stores", - "type" : "econtext_stores" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Lastschrift (ELV)", - "type" : "elv" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "231", - "name" : "POP Pankki" - }, - { - "id" : "551", - "name" : "Komerční banka" - }, - { - "id" : "232", - "name" : "Aktia" - }, - { - "id" : "552", - "name" : "Raiffeisen" - }, - { - "id" : "233", - "name" : "Säästöpankki" - }, - { - "id" : "750", - "name" : "Swedbank" - }, - { - "id" : "211", - "name" : "Nordea" - }, - { - "id" : "553", - "name" : "ČSOB" - }, - { - "id" : "234", - "name" : "S-Pankki" - }, - { - "id" : "751", - "name" : "SEB" - }, - { - "id" : "554", - "name" : "Moneta" - }, - { - "id" : "235", - "name" : "OmaSP" - }, - { - "id" : "752", - "name" : "Nordea" - }, - { - "id" : "213", - "name" : "Op-Pohjola" - }, - { - "id" : "555", - "name" : "UniCredit" - }, - { - "id" : "753", - "name" : "LHV" - }, - { - "id" : "556", - "name" : "Fio" - }, - { - "id" : "557", - "name" : "mBank" - }, - { - "id" : "216", - "name" : "Handelsbanken" - }, - { - "id" : "558", - "name" : "Air Bank" - }, - { - "id" : "260", - "name" : "Länsförsäkringar" - }, - { - "id" : "240", - "name" : "BankDeposit" - }, - { - "id" : "265", - "name" : "Sparbanken" - }, - { - "id" : "640", - "name" : "BankDeposit" - }, - { - "id" : "200", - "name" : "Ålandsbanken" - }, - { - "id" : "940", - "name" : "Swedbank" - }, - { - "id" : "500", - "name" : "Česká spořitelna" - }, - { - "id" : "720", - "name" : "Swedbank" - }, - { - "id" : "941", - "name" : "SEB" - }, - { - "id" : "204", - "name" : "Danske Bank" - }, - { - "id" : "721", - "name" : "SEB" - }, - { - "id" : "942", - "name" : "Citadele" - }, - { - "id" : "205", - "name" : "Handelsbanken" - }, - { - "id" : "722", - "name" : "DNB" - }, - { - "id" : "943", - "name" : "DNB" - }, - { - "id" : "206", - "name" : "Nordea" - }, - { - "id" : "723", - "name" : "Šiaulių bankas" - }, - { - "id" : "207", - "name" : "SEB" - }, - { - "id" : "724", - "name" : "Nordea" - }, - { - "id" : "505", - "name" : "Komerční banka" - }, - { - "id" : "208", - "name" : "Skandiabanken" - }, - { - "id" : "209", - "name" : "Swedbank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Bank Payment", - "type" : "entercash" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326", - "name" : "Dolomitenbank" - }, - { - "id" : "ee9fc487-ebe0-486c-8101-17dce5141a67", - "name" : "Raiffeissen Bankengruppe" - }, - { - "id" : "6765e225-a0dc-4481-9666-e26303d4f221", - "name" : "Hypo Tirol Bank AG" - }, - { - "id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc", - "name" : "Sparda Bank Wien" - }, - { - "id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f", - "name" : "Schoellerbank AG" - }, - { - "id" : "e2e97aaa-de4c-4e18-9431-d99790773433", - "name" : "Volksbank Gruppe" - }, - { - "id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9", - "name" : "Immo-Bank" - }, - { - "id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5", - "name" : "Bank Austria" - }, - { - "id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11", - "name" : "Easybank AG" - }, - { - "id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a", - "name" : "VR-BankBraunau" - }, - { - "id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9", - "name" : "Volkskreditbank" - }, - { - "id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3", - "name" : "Erste Bank und Sparkassen" - }, - { - "id" : "ba7199cc-f057-42f2-9856-2378abf21638", - "name" : "BAWAG P.S.K. Gruppe" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "EPS", - "type" : "eps" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "3x Oney", - "type" : "facilypay_3x" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "FR", - "name" : "France" - }, - { - "id" : "ES", - "name" : "Spain" - } - ], - "key" : "country", - "type" : "select" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "4x Oney", - "type" : "facilypay_4x" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "Fawry", - "type" : "fawry" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "GCash", - "type" : "gcash" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "details" : [ - { - "key" : "bic", - "type" : "text" - } - ], - "name" : "GiroPay", - "type" : "giropay" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Globe GCash", - "type" : "globegcash" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "GoPay Wallet", - "type" : "gopay_wallet" - }, - { - "name" : "OVO", - "type" : "grabpay_ID" - }, - { - "name" : "GrabPay", - "type" : "grabpay_PH" - }, - { - "name" : "GrabPay", - "type" : "grabpay_SG" - }, - { - "name" : "Hallmark Card", - "type" : "hallmarkcard" - }, - { - "name" : "HDFC", - "type" : "hdfc" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "name" : "igive", - "type" : "igive" - }, - { - "name" : "Korean Account Transfer (IniPay)", - "type" : "inicisIniPay_accounttransfer" - }, - { - "name" : "Korean Credit Cards (IniPay)", - "type" : "inicisIniPay_creditcard" - }, - { - "name" : "Korean Mobile Phone (IniPay)", - "type" : "inicisIniPay_mobilephone" - }, - { - "name" : "Korean Virtual Account (IniPay)", - "type" : "inicisIniPay_virtualaccount" - }, - { - "name" : "Korean Account Transfer (Mobile)", - "type" : "inicisMobile_accounttransfer" - }, - { - "name" : "Korean Credit Cards (Mobile)", - "type" : "inicisMobile_creditcard" - }, - { - "name" : "Korean Mobile Phone (Mobile)", - "type" : "inicisMobile_mobilephone" - }, - { - "name" : "Korean Virtual Account (Mobile)", - "type" : "inicisMobile_virtualaccount" - }, - { - "name" : "Korean Credit Cards", - "type" : "inicis_creditcard" - }, - { - "name" : "Interac® Online", - "type" : "interac" - }, - { - "name" : "Instant EFT", - "type" : "ipay" - }, - { - "name" : "iPay88", - "type" : "ipay88" - }, - { - "name" : "isracard", - "type" : "isracard" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "KakaoPay", - "type" : "kakaopay" - }, - { - "name" : "Karen Millen Card", - "type" : "karenmillen" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Bank Transfer", - "type" : "kcp_banktransfer" - }, - { - "name" : "Korea–issued cards", - "type" : "kcp_creditcard" - }, - { - "name" : "PayCo", - "type" : "kcp_payco" - }, - { - "name" : "Naver Pay", - "type" : "kcp_naverpay" - }, - { - "name" : "Virtual Account via KCP", - "type" : "kcp_va" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "name" : "Pay over time with Klarna.", - "type" : "klarna_account" - }, - { - "name" : "Klarna B2B", - "type" : "klarna_b2b" - }, - { - "name" : "Pay now with Klarna.", - "type" : "klarna_paynow" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "China Credit Card", - "type" : "lianlianpay_creditcard" - }, - { - "name" : "China Debit Card", - "type" : "lianlianpay_debitcard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Credit Card", - "type" : "lianlianpay_ebanking_credit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "4031000", - "name" : "Bank of Beijing" - }, - { - "id" : "01040000", - "name" : "Bank of China" - }, - { - "id" : "03020000", - "name" : "China Citic Bank" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03030000", - "name" : "China Everbright Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "03050000", - "name" : "China Minsheng Banking Group" - }, - { - "id" : "03040000", - "name" : "Hua Xia Bank Co" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03070000", - "name" : "PingAn Bank" - }, - { - "id" : "1000000", - "name" : "Postal Savings Bank of China" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Debit Card", - "type" : "lianlianpay_ebanking_debit" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "01030000", - "name" : "Agricultural Bank of China" - }, - { - "id" : "01050000", - "name" : "China Construction Bank" - }, - { - "id" : "03080000", - "name" : "China Merchants Bank" - }, - { - "id" : "01020000", - "name" : "Industrial and Commercial Bank of China" - }, - { - "id" : "03100000", - "name" : "Shanghai Pudong Development Bank" - } - ], - "key" : "issuer", - "type" : "select" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - } - ], - "name" : "China Online Banking - Enterprise", - "type" : "lianlianpay_ebanking_enterprise" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "name" : "Love2Shop GiftCard", - "type" : "love2shop" - }, - { - "details" : [ - { - "key" : "shopper.firstName", - "type" : "text" - }, - { - "key" : "shopper.lastName", - "type" : "text" - }, - { - "key" : "shopper.gender", - "type" : "text" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "countryCode", - "type" : "text" - } - ], - "name" : "mada", - "type" : "mada" - }, - { - "name" : "Mappin & Webb Card", - "type" : "mappinwebbcard" - }, - { - "name" : "MB WAY", - "type" : "mbway" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "Mercado Pago", - "type" : "mercadopago" - }, - { - "name" : "MobilePay", - "type" : "mobilepay" - }, - { - "name" : "AliPay via Razer Merchant Services", - "type" : "molpay_alipay" - }, - { - "name" : "7-Eleven", - "type" : "molpay_cash" - }, - { - "name" : "CIMB Virtual Account", - "type" : "molpay_cimb_va" - }, - { - "name" : "Malaysia E-Banking via Razer Merchant Services", - "type" : "molpay_ebanking_MY" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "vtcpay-vietinbank", - "name" : "Vietinbank" - }, - { - "id" : "vtcpay-bidv", - "name" : "BIDV" - }, - { - "id" : "vtcpay-agribank", - "name" : "Agribank" - }, - { - "id" : "vtcpay-mb", - "name" : "MB Bank" - }, - { - "id" : "vtcpay-sacombank", - "name" : "Sacombank" - }, - { - "id" : "vtcpay-dongabank", - "name" : "DongABank" - }, - { - "id" : "vtcpay-maritimebank", - "name" : "MaritimeBank" - }, - { - "id" : "vtcpay-vietcombank", - "name" : "Vietcombank" - }, - { - "id" : "vtcpay-acb", - "name" : "ACB" - }, - { - "id" : "vtcpay-techcombank", - "name" : "Techcombank" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Vietnam E-Banking", - "type" : "molpay_ebanking_VN" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "fpx_bimb", - "name" : "Bank Islam" - }, - { - "id" : "fpx_uob", - "name" : "UOB Bank" - }, - { - "id" : "fpx_cimbclicks", - "name" : "CIMB Clicks" - }, - { - "id" : "fpx_kfh", - "name" : "Kuwait Finance House" - }, - { - "id" : "fpx_rhb", - "name" : "RHB Now" - }, - { - "id" : "fpx_abmb", - "name" : "Alliance Bank" - }, - { - "id" : "fpx_amb", - "name" : "Am Online" - }, - { - "id" : "fpx_hsbc", - "name" : "HSBC" - }, - { - "id" : "fpx_abb", - "name" : "Affin Bank" - }, - { - "id" : "fpx_ocbc", - "name" : "OCBC Bank" - }, - { - "id" : "fpx_pbb", - "name" : "Public Bank" - }, - { - "id" : "fpx_scb", - "name" : "Standard Chartered Bank" - }, - { - "id" : "fpx_bsn", - "name" : "Bank Simpanan Nasional" - }, - { - "id" : "fpx_mb2u", - "name" : "Maybank2u" - }, - { - "id" : "fpx_hlb", - "name" : "Hong Leong Connect" - }, - { - "id" : "fpx_bmmb", - "name" : "Bank Muamalat" - }, - { - "id" : "fpx_bkrm", - "name" : "Bank Rakyat" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Malaysia E-Banking", - "type" : "molpay_ebanking_fpx_MY" - }, - { - "name" : "eNETS Debit", - "type" : "molpay_enetsd" - }, - { - "name" : "epay", - "type" : "molpay_epay" - }, - { - "name" : "Esapay", - "type" : "molpay_esapay" - }, - { - "name" : "MyClear FPX", - "type" : "molpay_fpx" - }, - { - "name" : "Maybank2u", - "type" : "molpay_maybank2u" - }, - { - "name" : "Nganluong", - "type" : "molpay_nganluong" - }, - { - "name" : "Tesco Lotus", - "type" : "molpay_paysbuy" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "RHB Now", - "type" : "molpay_rhb" - }, - { - "name" : "SAM by SingPost", - "type" : "molpay_singpost" - }, - { - "name" : "MOLWallet", - "type" : "molpay_wallet" - }, - { - "name" : "MoMo ATM", - "type" : "momo_atm" - }, - { - "name" : "Momo Wallet", - "type" : "momo_wallet" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "Multibanco", - "type" : "multibanco" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "BankAxess", - "type" : "netaxept_bankaxess" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "name" : "One Two Three", - "type" : "onetwothree" - }, - { - "name" : "Local Polish Payment Methods (P24)", - "type" : "onlineBanking_PL" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "1", - "name" : "Model Bank v2" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "Online banking", - "type" : "openbanking_UK" - }, - { - "name" : "Oxxo", - "type" : "oxxo" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "PayBright", - "type" : "paybright" - }, - { - "name" : "PayMaya Wallet", - "type" : "paymaya_wallet" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Payshop", - "type" : "payshop" - }, - { - "name" : "PayD AMT via Paythru", - "type" : "paythru_amt" - }, - { - "name" : "EFT via Paythru", - "type" : "paythru_eft" - }, - { - "name" : "PayTM", - "type" : "paytm" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "PayU UPI", - "type" : "payu_IN_upi" - }, - { - "name" : "EFT Pro via PayU", - "type" : "payu_ZA_eftpro" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "pix", - "type" : "pix" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "POLi", - "type" : "poli" - }, - { - "name" : "PPS", - "type" : "pps" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "PSE", - "type" : "pse" - }, - { - "details" : [ - { - "items" : [ - { - "id" : "+7", - "name" : "RU" - }, - { - "id" : "+9955", - "name" : "GE" - }, - { - "id" : "+507", - "name" : "PA" - }, - { - "id" : "+44", - "name" : "GB" - }, - { - "id" : "+992", - "name" : "TJ" - }, - { - "id" : "+370", - "name" : "LT" - }, - { - "id" : "+972", - "name" : "IL" - }, - { - "id" : "+996", - "name" : "KG" - }, - { - "id" : "+380", - "name" : "UA" - }, - { - "id" : "+84", - "name" : "VN" - }, - { - "id" : "+90", - "name" : "TR" - }, - { - "id" : "+994", - "name" : "AZ" - }, - { - "id" : "+374", - "name" : "AM" - }, - { - "id" : "+371", - "name" : "LV" - }, - { - "id" : "+91", - "name" : "IN" - }, - { - "id" : "+66", - "name" : "TH" - }, - { - "id" : "+373", - "name" : "MD" - }, - { - "id" : "+1", - "name" : "US" - }, - { - "id" : "+81", - "name" : "JP" - }, - { - "id" : "+998", - "name" : "UZ" - }, - { - "id" : "+77", - "name" : "KZ" - }, - { - "id" : "+375", - "name" : "BY" - }, - { - "id" : "+372", - "name" : "EE" - }, - { - "id" : "+40", - "name" : "RO" - }, - { - "id" : "+82", - "name" : "KR" - } - ], - "key" : "qiwiwallet.telephoneNumberPrefix", - "type" : "select" - }, - { - "key" : "qiwiwallet.telephoneNumber", - "type" : "text" - } - ], - "name" : "Qiwi Wallet", - "type" : "qiwiwallet" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "SafetyPay", - "type" : "safetypay" - }, - { - "name" : "SafetyPay Cash", - "type" : "safetypay_cash" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "SEB Direktbetalning", - "type" : "sebdirectpayment" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "7-Eleven", - "type" : "seveneleven" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "Swish", - "type" : "swish" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "TenPay", - "type" : "tenpay" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "TrueMoney", - "type" : "truemoney" - }, - { - "name" : "Trustly", - "type" : "trustly" - }, - { - "name" : "Online Banking by Trustpay", - "type" : "trustpay" - }, - { - "name" : "TWINT", - "type" : "twint" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "details" : [ - { - "key" : "virtualPaymentAddress", - "type" : "text" - } - ], - "name" : "UPI Collect", - "type" : "upi_collect" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "telephoneNumber", - "optional" : true, - "type" : "tel" - } - ], - "name" : "Vipps", - "type" : "vipps" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayMiniProgram" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayQR" - }, - { - "name" : "WeChat Pay", - "type" : "wechatpayWeb" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "WOS Card", - "type" : "woscard" - }, - { - "name" : "Alfa-Click", - "type" : "yandex_alfaclick" - }, - { - "name" : "Pay using bank card", - "type" : "yandex_bank_card" - }, - { - "name" : "Cash terminals", - "type" : "yandex_cash" - }, - { - "name" : "Pay using installments", - "type" : "yandex_installments" - }, - { - "name" : "YooMoney", - "type" : "yandex_money" - }, - { - "name" : "Promsvyazbank", - "type" : "yandex_promsvyazbank" - }, - { - "name" : "Sberbank Online", - "type" : "yandex_sberbank" - }, - { - "name" : "WebMoney", - "type" : "yandex_webmoney" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - }, - { - "name" : "Zip", - "type" : "zip" - } - ] - } - }, "post-paymentMethods-filtered" : { - "summary" : "Get payment methods based on the country and amount", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "countryCode" : "NL", - "shopperLocale" : "nl-NL", - "amount" : { - "currency" : "EUR", - "value" : 1000 - } - } - }, - "post-paymentMethods-filtered-200" : { "summary" : "Example response for request 'filtered'", "value" : { "paymentMethods" : [ @@ -14145,610 +11882,6 @@ "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j" } }, - "post-paymentMethods-include-oneclick-200" : { - "summary" : "Example response for request 'include-oneclick'", - "value" : { - "paymentMethods" : [ - { - "details" : [ - { - "items" : [ - { - "id" : "1121", - "name" : "Test Issuer" - }, - { - "id" : "1154", - "name" : "Test Issuer 5" - }, - { - "id" : "1153", - "name" : "Test Issuer 4" - }, - { - "id" : "1152", - "name" : "Test Issuer 3" - }, - { - "id" : "1151", - "name" : "Test Issuer 2" - }, - { - "id" : "1162", - "name" : "Test Issuer Cancelled" - }, - { - "id" : "1161", - "name" : "Test Issuer Pending" - }, - { - "id" : "1160", - "name" : "Test Issuer Refused" - }, - { - "id" : "1159", - "name" : "Test Issuer 10" - }, - { - "id" : "1158", - "name" : "Test Issuer 9" - }, - { - "id" : "1157", - "name" : "Test Issuer 8" - }, - { - "id" : "1156", - "name" : "Test Issuer 7" - }, - { - "id" : "1155", - "name" : "Test Issuer 6" - } - ], - "key" : "issuer", - "type" : "select" - } - ], - "name" : "iDEAL", - "type" : "ideal" - }, - { - "details" : [ - { - "key" : "encryptedCardNumber", - "type" : "cardToken" - }, - { - "key" : "encryptedSecurityCode", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryMonth", - "type" : "cardToken" - }, - { - "key" : "encryptedExpiryYear", - "type" : "cardToken" - }, - { - "key" : "holderName", - "optional" : true, - "type" : "text" - } - ], - "name" : "Credit Card", - "type" : "scheme" - }, - { - "name" : "PayPal", - "type" : "paypal" - }, - { - "details" : [ - { - "details" : [ - { - "key" : "firstName", - "type" : "text" - }, - { - "key" : "lastName", - "type" : "text" - }, - { - "items" : [ - { - "id" : "M", - "name" : "male" - }, - { - "id" : "F", - "name" : "female" - } - ], - "key" : "gender", - "type" : "radio" - }, - { - "key" : "dateOfBirth", - "type" : "date" - }, - { - "key" : "telephoneNumber", - "type" : "tel" - }, - { - "key" : "shopperEmail", - "type" : "emailAddress" - } - ], - "key" : "personalDetails", - "type" : "fieldSet" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "billingAddress", - "type" : "address" - }, - { - "key" : "separateDeliveryAddress", - "optional" : true, - "type" : "boolean", - "value" : "false" - }, - { - "details" : [ - { - "key" : "street", - "type" : "text" - }, - { - "key" : "houseNumberOrName", - "type" : "text" - }, - { - "key" : "city", - "type" : "text" - }, - { - "key" : "postalCode", - "type" : "text" - }, - { - "key" : "stateOrProvince", - "optional" : true, - "type" : "text" - }, - { - "items" : [ - { - "id" : "NL", - "name" : "Netherlands" - }, - { - "id" : "BE", - "name" : "Belgium" - } - ], - "key" : "country", - "type" : "select", - "value" : "NL" - } - ], - "key" : "deliveryAddress", - "optional" : true, - "type" : "address" - } - ], - "name" : "AfterPay Invoice", - "type" : "afterpay_default" - }, - { - "name" : "Pay later with Klarna.", - "type" : "klarna" - }, - { - "details" : [ - { - "key" : "sepa.ownerName", - "type" : "text" - }, - { - "key" : "sepa.ibanNumber", - "type" : "text" - } - ], - "name" : "SEPA Direct Debit", - "type" : "sepadirectdebit" - }, - { - "name" : "Paysafecard", - "type" : "paysafecard" - }, - { - "name" : "Bijenkorf Cadeaucard", - "type" : "bijcadeaucard" - }, - { - "name" : "Fonq Giftcard", - "type" : "fonqgiftcard" - }, - { - "name" : "Bank Transfer (NL)", - "type" : "bankTransfer_NL" - }, - { - "name" : "Pathe Giftcard", - "type" : "pathegiftcard" - }, - { - "name" : "VVV Giftcard", - "type" : "vvvgiftcard" - }, - { - "name" : "Podium Card", - "type" : "podiumcard" - }, - { - "name" : "RatePay Direct Debit", - "type" : "ratepay_directdebit" - }, - { - "name" : "Rituals Giftcard", - "type" : "rituals" - }, - { - "name" : "Hunkemoller Lingerie Card", - "type" : "hmlingerie" - }, - { - "name" : "Primera Cadeaukaart", - "type" : "primeracadeaucard" - }, - { - "name" : "Fashioncheque", - "type" : "fashioncheque" - }, - { - "name" : "NETELLER", - "type" : "neteller" - }, - { - "name" : "Adyen Voucher", - "type" : "adyen_test_voucher" - }, - { - "name" : "AfterPay B2B", - "type" : "afterpay_b2b" - }, - { - "name" : "AfterPay DirectDebit", - "type" : "afterpay_directdebit" - }, - { - "name" : "AliPay", - "type" : "alipay" - }, - { - "name" : "AliPay", - "type" : "alipay_wap" - }, - { - "details" : [ - { - "key" : "additionalData.androidpay.token", - "type" : "androidPayToken" - } - ], - "name" : "Android Pay", - "type" : "androidpay" - }, - { - "details" : [ - { - "key" : "additionalData.applepay.token", - "type" : "applePayToken" - } - ], - "name" : "Apple Pay", - "type" : "applepay" - }, - { - "name" : "Baby Gift Card", - "type" : "babygiftcard" - }, - { - "name" : "SEPA Bank Transfer", - "type" : "bankTransfer_IBAN" - }, - { - "name" : "Bloemen Giftcard", - "type" : "bloemengiftcard" - }, - { - "name" : "Boekenbon Giftcard", - "type" : "boekenbon" - }, - { - "name" : "Cash-Ticket", - "type" : "cashticket" - }, - { - "name" : "Chasin Giftcard", - "type" : "chasingiftcard" - }, - { - "name" : "ClickandBuy", - "type" : "clickandbuy" - }, - { - "name" : "Costes Giftcard", - "type" : "costesgiftcard" - }, - { - "name" : "custom_settlement", - "type" : "custom_settlement" - }, - { - "name" : "eft_directdebit_CA", - "type" : "eft_directdebit_CA" - }, - { - "name" : "Nationale Entertainment Card", - "type" : "entertainmentcard" - }, - { - "name" : "Expert Cadeaukaart", - "type" : "expertgiftcard" - }, - { - "name" : "FijnCadeau", - "type" : "fijncadeau" - }, - { - "name" : "Fleurop Bloemenbon", - "type" : "fleuropbloemenbon" - }, - { - "name" : "Gall & Gall", - "type" : "gallgall" - }, - { - "name" : "Generic GiftCard", - "type" : "genericgiftcard" - }, - { - "name" : "GiftFor2", - "type" : "giftfor2card" - }, - { - "name" : "Givex", - "type" : "givex" - }, - { - "name" : "Goldsmiths Card", - "type" : "goldsmithscard" - }, - { - "name" : "Hunkemoller Member Card", - "type" : "hmclub" - }, - { - "name" : "Phone Payment", - "type" : "ivr" - }, - { - "name" : "Landline phone", - "type" : "ivrLandline" - }, - { - "name" : "Mobile phone", - "type" : "ivrMobile" - }, - { - "name" : "Kado Wereld", - "type" : "kadowereld" - }, - { - "name" : "Karen Millen GiftCard", - "type" : "karenmillengiftcard" - }, - { - "name" : "Leisure Card", - "type" : "leisurecard" - }, - { - "name" : "Loods5 Cadeaukaart", - "type" : "loods5giftcard" - }, - { - "name" : "Loods5 Tegoedbon", - "type" : "loods5prepaidcard" - }, - { - "details" : [ - { - "key" : "additionalData.amazonPayToken", - "type" : "text" - } - ], - "name" : "Amazon Pay", - "supportsRecurring" : true, - "type" : "amazonpay" - }, - { - "name" : "MOLPoints", - "type" : "molpay_points" - }, - { - "name" : "Moneybookers", - "type" : "moneybookers" - }, - { - "name" : "De Nationale Musicalcard", - "type" : "musicalcard" - }, - { - "name" : "Nationale Bioscoopbon", - "type" : "nationalebioscoopbon" - }, - { - "name" : "Nationale Tuinbon", - "type" : "nationaletuinbon" - }, - { - "name" : "Nationale Verwen Cadeaubon", - "type" : "nationaleverwencadeaubon" - }, - { - "name" : "Onebip", - "type" : "onebip" - }, - { - "details" : [ - { - "key" : "additionalData.paywithgoogle.token", - "type" : "payWithGoogleToken" - } - ], - "name" : "Google Pay", - "type" : "paywithgoogle" - }, - { - "name" : "Plastix", - "type" : "plastix" - }, - { - "name" : "Pluim", - "type" : "pluimgiftcard" - }, - { - "name" : "Illicado Gift Card", - "type" : "prosodie_illicado" - }, - { - "name" : "RatePay Invoice", - "type" : "ratepay" - }, - { - "name" : "Rob Peetoom Giftcard", - "type" : "robpeetoomgiftcard" - }, - { - "name" : "Shoes&Accessories Cadeau", - "type" : "sagiftcard" - }, - { - "name" : "Score Giftcard", - "type" : "scoregiftcard" - }, - { - "name" : "Premium SMS", - "type" : "sms" - }, - { - "name" : "SVS", - "type" : "svs" - }, - { - "name" : "TCS Test GiftCard", - "type" : "tcstestgiftcard" - }, - { - "name" : "The Sting Giftcard", - "type" : "thestinggiftcard" - }, - { - "name" : "Ukash", - "type" : "ukash" - }, - { - "name" : "UnionPay", - "type" : "unionpay" - }, - { - "name" : "Valuelink", - "type" : "valuelink" - }, - { - "name" : "V&D Cadeaukaart", - "type" : "vdcadeaucard" - }, - { - "details" : [ - { - "key" : "additionalData.visacheckout.callId", - "type" : "text" - } - ], - "name" : "Visa Checkout", - "type" : "visacheckout" - }, - { - "name" : "VVV Cadeaubon", - "type" : "vvvcadeaubon" - }, - { - "name" : "Webshop Giftcard", - "type" : "webshopgiftcard" - }, - { - "name" : "WE Fashion Giftcard", - "type" : "wefashiongiftcard" - }, - { - "name" : "Western Union", - "type" : "westernunion" - }, - { - "name" : "Winkel Cheque", - "type" : "winkelcheque" - }, - { - "name" : "Your Gift", - "type" : "yourgift" - } - ] - } - }, "post-paymentSession-android" : { "summary" : "Set up a payment session (Android)", "value" : { @@ -14768,27 +11901,6 @@ } }, "post-paymentSession-enableOneClick" : { - "summary" : "Set up a payment session with the option to store card details", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "enableOneClick" : true, - "enableRecurring" : true, - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.7.0" - } - }, - "post-paymentSession-enableOneClick-200" : { "summary" : "Example response for request 'enableOneClick'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14845,25 +11957,6 @@ } }, "post-paymentSession-web" : { - "summary" : "Set up a payment session (Web)", - "value" : { - "amount" : { - "currency" : "EUR", - "value" : 17408 - }, - "reference" : "Your order number", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "channel" : "Web", - "html" : true, - "origin" : "https://www.yourwebsite.com", - "returnUrl" : "https://www.yourshop.com/checkout/result", - "countryCode" : "NL", - "shopperLocale" : "nl_NL", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "sdkVersion" : "1.9.5" - } - }, - "post-paymentSession-web-200" : { "summary" : "Example response for request 'web'", "value" : { "paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..." @@ -14933,24 +12026,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-2-web-200" : { - "summary" : "Example response for request 'card-3d-secure-2-web'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "097410", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "C", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VHQOF" - }, - "pspReference" : "993617895214576G", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-direct" : { "summary" : "Make card payment with 3D Secure redirect authentication", "value" : { @@ -14975,24 +12050,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-direct-200" : { - "summary" : "Example response for request 'card-3d-secure-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "054817", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VIO26" - }, - "pspReference" : "993617895217578K", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-3d-secure-securedfields" : { "summary" : "Make a payment with 3D Secure 2 native authentication", "value" : { @@ -15017,24 +12074,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-3d-secure-securedfields-200" : { - "summary" : "Example response for request 'card-3d-secure-securedfields'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "046773", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCAVH" - }, - "pspReference" : "993617895196572H", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-direct" : { "summary" : "Make a card payment", "value" : { @@ -15055,44 +12094,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-card-direct-200" : { - "summary" : "Example response for request 'card-direct'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "044925", - "avsResult" : "4 AVS not supported for this card type", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VEP3H" - }, - "pspReference" : "993617895204576J", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-card-securedfields" : { - "summary" : "Make a card payment (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-card-securedfields-200" : { "summary" : "Example response for request 'card-securedfields'", "value" : { "additionalData" : { @@ -15127,29 +12129,6 @@ } }, "post-payments-enableOneClick-SF" : { - "summary" : "Tokenize card details for one-off payments (using encrypted card details)", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "encryptedCardNumber" : "test_4111111111111111", - "encryptedExpiryMonth" : "test_03", - "encryptedExpiryYear" : "test_2030", - "encryptedSecurityCode" : "test_737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "CardOnFile", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-enableOneClick-SF-200" : { "summary" : "Example response for request 'enableOneClick-SF'", "value" : { "additionalData" : { @@ -15194,27 +12173,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-enableOneClick-raw-200" : { - "summary" : "Example response for request 'enableOneClick-raw'", - "value" : { - "additionalData" : { - "cvcResult" : "1 Matches", - "authCode" : "003704", - "avsResult" : "4 AVS not supported for this card type", - "recurring.recurringDetailReference" : "9916178934434753", - "recurringProcessingModel" : "CardOnFile", - "avsResultRaw" : "4", - "cvcResultRaw" : "M", - "refusalReasonRaw" : "AUTHORISED", - "recurring.shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "acquirerCode" : "TestPmmAcquirer", - "acquirerReference" : "8PQMP9VCKO0" - }, - "pspReference" : "993617895197573E", - "resultCode" : "Authorised", - "merchantReference" : "string" - } - }, "post-payments-giropay" : { "summary" : "Make a giropay payment", "value" : { @@ -15230,30 +12188,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-giropay-200" : { - "summary" : "Example response for request 'giropay'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-googlepay" : { "summary" : "Make a Google Pay payment", "value" : { @@ -15286,30 +12220,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-ideal-200" : { - "summary" : "Example response for request 'ideal'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-klarna" : { "summary" : "Make a Klarna payment", "value" : { @@ -15450,30 +12360,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-payments-sofort-200" : { - "summary" : "Example response for request 'sofort'", - "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", - "type" : "redirect" - }, - "details" : [ - { - "key" : "payload", - "type" : "text" - } - ], - "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==", - "redirect" : { - "method" : "GET", - "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" - } - } - }, "post-payments-split" : { "summary" : "Split a payment between a sub-merchant and a platform account", "value" : { @@ -15513,30 +12399,6 @@ } }, "post-payments-subscription-first-transaction" : { - "summary" : "Tokenize card details for a subscription", - "value" : { - "amount" : { - "currency" : "USD", - "value" : 1000 - }, - "reference" : "Your order number", - "paymentMethod" : { - "type" : "scheme", - "number" : "4111111111111111", - "expiryMonth" : "03", - "expiryYear" : "2030", - "holderName" : "John Smith", - "cvc" : "737" - }, - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "storePaymentMethod" : true, - "shopperInteraction" : "Ecommerce", - "recurringProcessingModel" : "Subscription", - "returnUrl" : "https://your-company.com/...", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-payments-subscription-first-transaction-200" : { "summary" : "Example response for request 'subscription-first-transaction'", "value" : { "additionalData" : { @@ -15559,4 +12421,4 @@ } } } -} \ No newline at end of file +} diff --git a/json/FundService-v3.json b/json/FundService-v3.json index 9e08fb9..2212f06 100644 --- a/json/FundService-v3.json +++ b/json/FundService-v3.json @@ -23,6 +23,9 @@ "paths" : { "/accountHolderBalance" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve the balance(s) of an account holder.", "description" : "This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account's balances are on a per-currency basis (i.e., an account may have multiple balances: one per currency).", "operationId" : "post-accountHolderBalance", @@ -118,6 +121,9 @@ }, "/accountHolderTransactionList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of transactions.", "description" : "This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included on the list can be specified. Each call will return a maximum of fifty (50) Transactions per account; in order to retrieve the following set of Transactions another call should be made with the 'page' value incremented. Note that Transactions are ordered with most recent first.", "operationId" : "post-accountHolderTransactionList", @@ -216,6 +222,9 @@ }, "/payoutAccountHolder" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disburse a specified amount from an account to the account holder.", "description" : "This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder.", "operationId" : "post-payoutAccountHolder", @@ -321,6 +330,9 @@ }, "/refundFundsTransfer" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Make a refund of the existing transfer funds transfer.", "description" : "This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. ", "operationId" : "post-refundFundsTransfer", @@ -426,6 +438,9 @@ }, "/refundNotPaidOutTransfers" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Refund all transactions of an account since the most recent payout.", "description" : "This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details.", "operationId" : "post-refundNotPaidOutTransfers", @@ -531,6 +546,9 @@ }, "/setupBeneficiary" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.", "description" : "This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.", "operationId" : "post-setupBeneficiary", @@ -636,6 +654,9 @@ }, "/transferFunds" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Transfer funds from one platform account to another.", "description" : "This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. The transfer must include a transfer code, which should be determined by the marketplace, in compliance with local regulations.", "operationId" : "post-transferFunds", @@ -1067,7 +1088,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.", "type" : "string" } @@ -1085,7 +1106,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.", "type" : "string" }, @@ -1288,12 +1309,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -1386,7 +1407,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.", "type" : "string" }, @@ -1409,7 +1430,7 @@ "TransferFundsResponse" : { "properties" : { "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.", "type" : "string" }, diff --git a/json/FundService-v5.json b/json/FundService-v5.json index f59b08f..06c7de6 100644 --- a/json/FundService-v5.json +++ b/json/FundService-v5.json @@ -23,6 +23,9 @@ "paths" : { "/accountHolderBalance" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve the balance(s) of an account holder.", "description" : "This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account's balances are on a per-currency basis (i.e., an account may have multiple balances: one per currency).", "operationId" : "post-accountHolderBalance", @@ -118,6 +121,9 @@ }, "/accountHolderTransactionList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of transactions.", "description" : "This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included on the list can be specified. Each call will return a maximum of fifty (50) Transactions per account; in order to retrieve the following set of Transactions another call should be made with the 'page' value incremented. Note that Transactions are ordered with most recent first.", "operationId" : "post-accountHolderTransactionList", @@ -216,6 +222,9 @@ }, "/payoutAccountHolder" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disburse a specified amount from an account to the account holder.", "description" : "This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder.", "operationId" : "post-payoutAccountHolder", @@ -321,6 +330,9 @@ }, "/refundFundsTransfer" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Make a refund of the existing transfer funds transfer.", "description" : "This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. ", "operationId" : "post-refundFundsTransfer", @@ -426,6 +438,9 @@ }, "/refundNotPaidOutTransfers" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Refund all transactions of an account since the most recent payout.", "description" : "This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details.", "operationId" : "post-refundNotPaidOutTransfers", @@ -531,6 +546,9 @@ }, "/setupBeneficiary" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.", "description" : "This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.", "operationId" : "post-setupBeneficiary", @@ -636,6 +654,9 @@ }, "/transferFunds" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Transfer funds from one platform account to another.", "description" : "This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. The transfer must include a transfer code, which should be determined by the marketplace, in compliance with local regulations.", "operationId" : "post-transferFunds", @@ -775,7 +796,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -874,7 +895,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -944,7 +965,7 @@ "type" : "string" }, "bankAccountReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Merchant reference to the bank account.", "type" : "string" }, @@ -1048,7 +1069,7 @@ "type" : "array" }, "onHoldBalance" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The list of on hold balances held by the account.", "items" : { "$ref" : "#/components/schemas/Amount" @@ -1180,6 +1201,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -1200,6 +1222,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -1268,17 +1291,17 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.", "type" : "string" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The unique ID of the payout method held by the Account Holder to which the payout is to be made.\nIf left blank, a payout instrument is automatically selected.", "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "default" : "STANDARD", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ @@ -1302,7 +1325,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1310,12 +1333,12 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.", "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "default" : "STANDARD", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ @@ -1358,7 +1381,7 @@ "RefundFundsTransferResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1406,7 +1429,7 @@ "RefundNotPaidOutTransfersResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1471,7 +1494,7 @@ "SetupBeneficiaryResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1532,12 +1555,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -1630,7 +1653,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.", "type" : "string" }, @@ -1653,7 +1676,7 @@ "TransferFundsResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1661,7 +1684,7 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.", "type" : "string" }, diff --git a/json/FundService-v6.json b/json/FundService-v6.json index 5733603..38c0da1 100644 --- a/json/FundService-v6.json +++ b/json/FundService-v6.json @@ -23,6 +23,9 @@ "paths" : { "/accountHolderBalance" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve the balance(s) of an account holder.", "description" : "This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account's balances are on a per-currency basis (i.e., an account may have multiple balances: one per currency).", "operationId" : "post-accountHolderBalance", @@ -118,6 +121,9 @@ }, "/accountHolderTransactionList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of transactions.", "description" : "This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included on the list can be specified. Each call will return a maximum of fifty (50) Transactions per account; in order to retrieve the following set of Transactions another call should be made with the 'page' value incremented. Note that Transactions are ordered with most recent first.", "operationId" : "post-accountHolderTransactionList", @@ -216,6 +222,9 @@ }, "/payoutAccountHolder" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disburse a specified amount from an account to the account holder.", "description" : "This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder.", "operationId" : "post-payoutAccountHolder", @@ -321,6 +330,9 @@ }, "/refundFundsTransfer" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Make a refund of the existing transfer funds transfer.", "description" : "This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders. ", "operationId" : "post-refundFundsTransfer", @@ -426,6 +438,9 @@ }, "/refundNotPaidOutTransfers" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Refund all transactions of an account since the most recent payout.", "description" : "This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details.", "operationId" : "post-refundNotPaidOutTransfers", @@ -531,6 +546,9 @@ }, "/setupBeneficiary" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.", "description" : "This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.", "operationId" : "post-setupBeneficiary", @@ -636,6 +654,9 @@ }, "/transferFunds" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Transfer funds from one platform account to another.", "description" : "This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. The transfer must include a transfer code, which should be determined by the marketplace, in compliance with local regulations.", "operationId" : "post-transferFunds", @@ -775,7 +796,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -874,7 +895,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -944,7 +965,7 @@ "type" : "string" }, "bankAccountReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Merchant reference to the bank account.", "type" : "string" }, @@ -1048,7 +1069,7 @@ "type" : "array" }, "onHoldBalance" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The list of on hold balances held by the account.", "items" : { "$ref" : "#/components/schemas/Amount" @@ -1180,6 +1201,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -1200,6 +1222,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -1268,17 +1291,17 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.", "type" : "string" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The unique ID of the payout method held by the Account Holder to which the payout is to be made.\nIf left blank, a payout instrument is automatically selected.", "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "default" : "STANDARD", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ @@ -1302,7 +1325,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1310,12 +1333,12 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.", "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "default" : "STANDARD", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ @@ -1358,7 +1381,7 @@ "RefundFundsTransferResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1406,7 +1429,7 @@ "RefundNotPaidOutTransfersResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1471,7 +1494,7 @@ "SetupBeneficiaryResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1532,12 +1555,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -1630,7 +1653,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.", "type" : "string" }, @@ -1653,7 +1676,7 @@ "TransferFundsResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1661,7 +1684,7 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.", "type" : "string" }, diff --git a/json/HopService-v1.json b/json/HopService-v1.json index 1d664e2..1950702 100644 --- a/json/HopService-v1.json +++ b/json/HopService-v1.json @@ -24,6 +24,9 @@ "paths" : { "/getOnboardingUrl" : { "post" : { + "tags" : [ + "Hosted Onboarding Page" + ], "summary" : "Get a link to a Adyen-hosted onboarding page.", "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/platforms/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", @@ -114,6 +117,9 @@ }, "/getPciQuestionnaireUrl" : { "post" : { + "tags" : [ + "PCI Compliance Questionnaire Page" + ], "summary" : "Get a link to a PCI compliance questionnaire.", "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/platforms/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", @@ -208,19 +214,23 @@ "CollectInformation" : { "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Default is **true**.", + "type" : "boolean" + }, + "legalArrangementDetails" : { + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", "type" : "boolean" }, "pciQuestionnaire" : { - "description" : "Indicates whether answers to a PCI questionnaire must be collected. Defaults to **true**.", + "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", "type" : "boolean" }, "shareholderDetails" : { @@ -284,7 +294,6 @@ "currency", "currencyCode", "dateOfBirth", - "description", "destinationAccountCode", "document", "documentExpirationDate", @@ -306,8 +315,6 @@ "houseNumberOrName", "iban", "idCard", - "idCardBack", - "idCardFront", "idNumber", "identityDocument", "individualDetails", @@ -345,13 +352,13 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", "postalCode", "primaryCurrency", "reason", - "registrationNumber", "returnUrl", "schedule", "shareholder", @@ -365,6 +372,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -447,7 +455,7 @@ "GetOnboardingUrlResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information about any invalid fields.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -490,7 +498,7 @@ "GetPciUrlResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information about any invalid fields.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" diff --git a/json/HopService-v5.json b/json/HopService-v5.json index 1de82e3..92318c9 100644 --- a/json/HopService-v5.json +++ b/json/HopService-v5.json @@ -24,6 +24,9 @@ "paths" : { "/getOnboardingUrl" : { "post" : { + "tags" : [ + "Hosted Onboarding Page" + ], "summary" : "Get a link to a Adyen-hosted onboarding page.", "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/platforms/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", @@ -114,6 +117,9 @@ }, "/getPciQuestionnaireUrl" : { "post" : { + "tags" : [ + "PCI Compliance Questionnaire Page" + ], "summary" : "Get a link to a PCI compliance questionnaire.", "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/platforms/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", @@ -208,19 +214,23 @@ "CollectInformation" : { "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Default is **true**.", + "type" : "boolean" + }, + "legalArrangementDetails" : { + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", "type" : "boolean" }, "pciQuestionnaire" : { - "description" : "Indicates whether answers to a PCI questionnaire must be collected. Defaults to **true**.", + "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", "type" : "boolean" }, "shareholderDetails" : { @@ -345,6 +355,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -365,6 +376,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -447,7 +459,7 @@ "GetOnboardingUrlResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information about any invalid fields.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -486,7 +498,7 @@ "GetPciUrlResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information about any invalid fields.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" diff --git a/json/HopService-v6.json b/json/HopService-v6.json index 575b04b..b74c5cf 100644 --- a/json/HopService-v6.json +++ b/json/HopService-v6.json @@ -24,6 +24,9 @@ "paths" : { "/getOnboardingUrl" : { "post" : { + "tags" : [ + "Hosted Onboarding Page" + ], "summary" : "Get a link to a Adyen-hosted onboarding page.", "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/platforms/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", @@ -114,6 +117,9 @@ }, "/getPciQuestionnaireUrl" : { "post" : { + "tags" : [ + "PCI Compliance Questionnaire Page" + ], "summary" : "Get a link to a PCI compliance questionnaire.", "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/platforms/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", @@ -208,19 +214,23 @@ "CollectInformation" : { "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Default is **true**.", + "type" : "boolean" + }, + "legalArrangementDetails" : { + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", "type" : "boolean" }, "pciQuestionnaire" : { - "description" : "Indicates whether answers to a PCI questionnaire must be collected. Defaults to **true**.", + "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", "type" : "boolean" }, "shareholderDetails" : { @@ -345,6 +355,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -365,6 +376,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -447,7 +459,7 @@ "GetOnboardingUrlResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information about any invalid fields.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -486,7 +498,7 @@ "GetPciUrlResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information about any invalid fields.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" diff --git a/json/MarketPayNotificationService-v3.json b/json/MarketPayNotificationService-v3.json index 04ea687..cb48199 100644 --- a/json/MarketPayNotificationService-v3.json +++ b/json/MarketPayNotificationService-v3.json @@ -22,6 +22,9 @@ "webhooks" : { "/ACCOUNT_CLOSED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the closure of an account.", "description" : "This notification is sent when an account has been closed.", "operationId" : "post-ACCOUNT_CLOSED", @@ -72,6 +75,9 @@ }, "/ACCOUNT_CREATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the creation of an account.", "description" : "This notification is sent when an account has been created.", "operationId" : "post-ACCOUNT_CREATED", @@ -112,6 +118,9 @@ }, "/ACCOUNT_FUNDS_BELOW_THRESHOLD" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when a liable account current funds are below configured threshold.", "description" : "This notification is sent when a liable account's current funds are below configured threshold from the Adyen platform.", "operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD", @@ -152,6 +161,9 @@ }, "/ACCOUNT_HOLDER_CREATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the creation of an account holder.", "description" : "This notification is sent when an account holder has been created.", "operationId" : "post-ACCOUNT_HOLDER_CREATED", @@ -192,6 +204,9 @@ }, "/ACCOUNT_HOLDER_PAYOUT" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon a payout to an account holder.", "description" : "This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled.", "operationId" : "post-ACCOUNT_HOLDER_PAYOUT", @@ -232,6 +247,9 @@ }, "/ACCOUNT_HOLDER_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of an account holder.", "description" : "This notification is sent when the status of an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE", @@ -272,6 +290,9 @@ }, "/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of a store tied to an account holder.", "description" : "This notification is sent when the status of a store tied to an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE", @@ -312,6 +333,9 @@ }, "/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon an upcoming deadline.", "description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.", "operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE", @@ -352,6 +376,9 @@ }, "/ACCOUNT_HOLDER_UPDATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the update of an account holder.", "description" : "This notification is sent when an account holder has been updated.", "operationId" : "post-ACCOUNT_HOLDER_UPDATED", @@ -392,6 +419,9 @@ }, "/ACCOUNT_HOLDER_VERIFICATION" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the receipt of KYC Verification results.", "description" : "This notification is sent when KYC Verification results are made available.", "operationId" : "post-ACCOUNT_HOLDER_VERIFICATION", @@ -432,6 +462,9 @@ }, "/ACCOUNT_UPDATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the update of an account.", "description" : "This notification is sent when an account has been updated.", "operationId" : "post-ACCOUNT_UPDATED", @@ -472,6 +505,9 @@ }, "/BENEFICIARY_SETUP" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the setup of a beneficiary.", "description" : "This notification is sent when a benefactor/beneficiary relationship between accounts has been set up.", "operationId" : "post-BENEFICIARY_SETUP", @@ -512,6 +548,9 @@ }, "/COMPENSATE_NEGATIVE_BALANCE" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the compensation of negative account balances.", "description" : "This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate for the overdraft.", "operationId" : "post-COMPENSATE_NEGATIVE_BALANCE", @@ -552,6 +591,9 @@ }, "/DIRECT_DEBIT_INITIATED" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when an automated direct debit is initiated.", "description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.", "operationId" : "post-DIRECT_DEBIT_INITIATED", @@ -592,6 +634,9 @@ }, "/PAYMENT_FAILURE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a booking for a capture or refund fails.", "description" : "This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to your platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", @@ -632,6 +677,9 @@ }, "/REFUND_FUNDS_TRANSFER" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer refund of funds between accounts.", "description" : "This notification is sent when the refund of funds from an account have been transferred to another account.", "operationId" : "post-REFUND_FUNDS_TRANSFER", @@ -672,6 +720,9 @@ }, "/REPORT_AVAILABLE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a report is made available.", "description" : "This notification is sent when a report has been made available.", "operationId" : "post-REPORT_AVAILABLE", @@ -712,6 +763,9 @@ }, "/SCHEDULED_REFUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call.", "description" : "This notification is sent when a 'Refund Transfers Not Paid Out' call has been processed and the associated refunds have been scheduled.", "operationId" : "post-SCHEDULED_REFUNDS", @@ -752,6 +806,9 @@ }, "/TRANSFER_FUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer of funds between accounts.", "description" : "This notification is sent when the funds from an account have been transferred to another account.", "operationId" : "post-TRANSFER_FUNDS", @@ -1011,6 +1068,10 @@ "description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.", "type" : "object" }, + "principalBusinessAddress" : { + "description" : "The principal business address of the account holder.", + "$ref" : "#/components/schemas/ViasAddress" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -1083,7 +1144,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The merchant reference.", "type" : "string" }, @@ -1170,12 +1231,12 @@ "type" : "string" }, "newStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "oldStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The former status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -1438,7 +1499,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1464,7 +1525,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1708,6 +1769,13 @@ "description" : "The legal name of the company.", "type" : "string" }, + "listedUltimateParentCompany" : { + "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", + "items" : { + "$ref" : "#/components/schemas/UltimateParentCompany" + }, + "type" : "array" + }, "shareholders" : { "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check).", "items" : { @@ -1739,7 +1807,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -1839,12 +1907,12 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1864,7 +1932,7 @@ "type" : "boolean" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -1899,7 +1967,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -2048,7 +2116,6 @@ "currency", "currencyCode", "dateOfBirth", - "description", "destinationAccountCode", "document", "documentExpirationDate", @@ -2070,8 +2137,6 @@ "houseNumberOrName", "iban", "idCard", - "idCardBack", - "idCardFront", "idNumber", "identityDocument", "individualDetails", @@ -2109,13 +2174,13 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", "postalCode", "primaryCurrency", "reason", - "registrationNumber", "returnUrl", "schedule", "shareholder", @@ -2129,6 +2194,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -2910,12 +2976,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -3022,7 +3088,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The reference provided by the merchant.", "type" : "string" }, @@ -3046,6 +3112,46 @@ "transferCode" ] }, + "UltimateParentCompany" : { + "properties" : { + "address" : { + "description" : "Address of the ultimate parent company.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "businessDetails" : { + "description" : "Details about the ultimate parent company's business.", + "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" + }, + "ultimateParentCompanyCode" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", + "type" : "string" + } + } + }, + "UltimateParentCompanyBusinessDetails" : { + "properties" : { + "legalBusinessName" : { + "description" : "The legal name of the company.", + "type" : "string" + }, + "registrationNumber" : { + "description" : "The registration number of the company.", + "type" : "string" + }, + "stockExchange" : { + "description" : "Market Identifier Code (MIC).", + "type" : "string" + }, + "stockNumber" : { + "description" : "International Securities Identification Number (ISIN).", + "type" : "string" + }, + "stockTicker" : { + "description" : "Stock Ticker symbol.", + "type" : "string" + } + } + }, "UpdateAccountHolderResponse" : { "properties" : { "accountHolderCode" : { @@ -3057,12 +3163,12 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3089,7 +3195,7 @@ "type" : "array" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -3194,7 +3300,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" diff --git a/json/MarketPayNotificationService-v4.json b/json/MarketPayNotificationService-v4.json index 8fd19c8..d59c8ba 100644 --- a/json/MarketPayNotificationService-v4.json +++ b/json/MarketPayNotificationService-v4.json @@ -22,6 +22,9 @@ "webhooks" : { "/ACCOUNT_CLOSED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the closure of an account.", "description" : "This notification is sent when an account has been closed.", "operationId" : "post-ACCOUNT_CLOSED", @@ -72,6 +75,9 @@ }, "/ACCOUNT_CREATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the creation of an account.", "description" : "This notification is sent when an account has been created.", "operationId" : "post-ACCOUNT_CREATED", @@ -112,6 +118,9 @@ }, "/ACCOUNT_FUNDS_BELOW_THRESHOLD" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when a liable account current funds are below configured threshold.", "description" : "This notification is sent when a liable account's current funds are below configured threshold from the Adyen platform.", "operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD", @@ -152,6 +161,9 @@ }, "/ACCOUNT_HOLDER_CREATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the creation of an account holder.", "description" : "This notification is sent when an account holder has been created.", "operationId" : "post-ACCOUNT_HOLDER_CREATED", @@ -192,6 +204,9 @@ }, "/ACCOUNT_HOLDER_PAYOUT" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon a payout to an account holder.", "description" : "This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled.", "operationId" : "post-ACCOUNT_HOLDER_PAYOUT", @@ -232,6 +247,9 @@ }, "/ACCOUNT_HOLDER_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of an account holder.", "description" : "This notification is sent when the status of an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE", @@ -272,6 +290,9 @@ }, "/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of a store tied to an account holder.", "description" : "This notification is sent when the status of a store tied to an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE", @@ -312,6 +333,9 @@ }, "/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon an upcoming deadline.", "description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.", "operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE", @@ -352,6 +376,9 @@ }, "/ACCOUNT_HOLDER_UPDATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the update of an account holder.", "description" : "This notification is sent when an account holder has been updated.", "operationId" : "post-ACCOUNT_HOLDER_UPDATED", @@ -392,6 +419,9 @@ }, "/ACCOUNT_HOLDER_VERIFICATION" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the receipt of KYC Verification results.", "description" : "This notification is sent when KYC Verification results are made available.", "operationId" : "post-ACCOUNT_HOLDER_VERIFICATION", @@ -432,6 +462,9 @@ }, "/ACCOUNT_UPDATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the update of an account.", "description" : "This notification is sent when an account has been updated.", "operationId" : "post-ACCOUNT_UPDATED", @@ -472,6 +505,9 @@ }, "/BENEFICIARY_SETUP" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the setup of a beneficiary.", "description" : "This notification is sent when a benefactor/beneficiary relationship between accounts has been set up.", "operationId" : "post-BENEFICIARY_SETUP", @@ -512,6 +548,9 @@ }, "/COMPENSATE_NEGATIVE_BALANCE" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the compensation of negative account balances.", "description" : "This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate for the overdraft.", "operationId" : "post-COMPENSATE_NEGATIVE_BALANCE", @@ -552,6 +591,9 @@ }, "/DIRECT_DEBIT_INITIATED" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when an automated direct debit is initiated.", "description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.", "operationId" : "post-DIRECT_DEBIT_INITIATED", @@ -592,6 +634,9 @@ }, "/PAYMENT_FAILURE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a booking for a capture or refund fails.", "description" : "This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to your platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", @@ -632,6 +677,9 @@ }, "/REFUND_FUNDS_TRANSFER" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer refund of funds between accounts.", "description" : "This notification is sent when the refund of funds from an account have been transferred to another account.", "operationId" : "post-REFUND_FUNDS_TRANSFER", @@ -672,6 +720,9 @@ }, "/REPORT_AVAILABLE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a report is made available.", "description" : "This notification is sent when a report has been made available.", "operationId" : "post-REPORT_AVAILABLE", @@ -712,6 +763,9 @@ }, "/SCHEDULED_REFUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call.", "description" : "This notification is sent when a 'Refund Transfers Not Paid Out' call has been processed and the associated refunds have been scheduled.", "operationId" : "post-SCHEDULED_REFUNDS", @@ -752,6 +806,9 @@ }, "/TRANSFER_FUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer of funds between accounts.", "description" : "This notification is sent when the funds from an account have been transferred to another account.", "operationId" : "post-TRANSFER_FUNDS", @@ -800,7 +857,7 @@ "$ref" : "#/components/schemas/CloseAccountResponse" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -838,7 +895,7 @@ "$ref" : "#/components/schemas/CreateAccountResponse" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -902,7 +959,7 @@ "$ref" : "#/components/schemas/AccountFundsBelowThresholdNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -968,7 +1025,7 @@ "$ref" : "#/components/schemas/CreateAccountHolderResponse" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1039,6 +1096,10 @@ "description" : "A set of key and value pairs for general use by the account holder or merchant.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.", "type" : "object" }, + "principalBusinessAddress" : { + "description" : "The principal business address of the account holder.", + "$ref" : "#/components/schemas/ViasAddress" + }, "webAddress" : { "description" : "The URL of the website of the account holder.", "type" : "string" @@ -1057,7 +1118,7 @@ "$ref" : "#/components/schemas/AccountHolderPayoutNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1118,7 +1179,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The merchant reference.", "type" : "string" }, @@ -1175,7 +1236,7 @@ "$ref" : "#/components/schemas/AccountHolderStatusChangeNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1212,12 +1273,12 @@ "type" : "string" }, "newStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "oldStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The former status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -1239,7 +1300,7 @@ "$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1279,7 +1340,7 @@ "$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1359,7 +1420,7 @@ "$ref" : "#/components/schemas/UpdateAccountHolderResponse" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1397,7 +1458,7 @@ "$ref" : "#/components/schemas/AccountHolderVerificationNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1447,7 +1508,7 @@ "type" : "string" }, "statusSummary" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A summary of the verification status.", "$ref" : "#/components/schemas/KYCCheckSummary" }, @@ -1505,7 +1566,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1531,7 +1592,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1545,7 +1606,7 @@ "$ref" : "#/components/schemas/UpdateAccountResponse" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1706,7 +1767,7 @@ "$ref" : "#/components/schemas/BeneficiarySetupNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1789,8 +1850,15 @@ "description" : "The legal name of the company.", "type" : "string" }, + "listedUltimateParentCompany" : { + "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", + "items" : { + "$ref" : "#/components/schemas/UltimateParentCompany" + }, + "type" : "array" + }, "registrationNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The registration number of the company.", "type" : "string" }, @@ -1825,7 +1893,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -1851,7 +1919,7 @@ "$ref" : "#/components/schemas/CompensateNegativeBalanceNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1932,17 +2000,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the new account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1950,14 +2018,12 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The type of legal entity of the new account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, @@ -1974,7 +2040,7 @@ "type" : "boolean" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -1998,7 +2064,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, @@ -2015,7 +2081,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -2043,7 +2109,7 @@ "$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2232,6 +2298,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -2252,6 +2319,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -2509,7 +2577,7 @@ "$ref" : "#/components/schemas/PaymentFailureNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2652,7 +2720,7 @@ "$ref" : "#/components/schemas/RefundFundsTransferNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2734,7 +2802,7 @@ "$ref" : "#/components/schemas/ReportAvailableNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2797,7 +2865,7 @@ "$ref" : "#/components/schemas/ScheduledRefundsNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3048,12 +3116,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -3125,7 +3193,7 @@ "$ref" : "#/components/schemas/TransferFundsNotificationContent" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3167,7 +3235,7 @@ "type" : "string" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The reference provided by the merchant.", "type" : "string" }, @@ -3191,6 +3259,46 @@ "transferCode" ] }, + "UltimateParentCompany" : { + "properties" : { + "address" : { + "description" : "Address of the ultimate parent company.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "businessDetails" : { + "description" : "Details about the ultimate parent company's business.", + "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" + }, + "ultimateParentCompanyCode" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", + "type" : "string" + } + } + }, + "UltimateParentCompanyBusinessDetails" : { + "properties" : { + "legalBusinessName" : { + "description" : "The legal name of the company.", + "type" : "string" + }, + "registrationNumber" : { + "description" : "The registration number of the company.", + "type" : "string" + }, + "stockExchange" : { + "description" : "Market Identifier Code (MIC).", + "type" : "string" + }, + "stockNumber" : { + "description" : "International Securities Identification Number (ISIN).", + "type" : "string" + }, + "stockTicker" : { + "description" : "Stock Ticker symbol.", + "type" : "string" + } + } + }, "UpdateAccountHolderResponse" : { "properties" : { "accountHolderCode" : { @@ -3202,17 +3310,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3220,14 +3328,12 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The legal entity of the account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, @@ -3251,7 +3357,7 @@ "type" : "array" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -3269,7 +3375,7 @@ "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, @@ -3362,7 +3468,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" diff --git a/json/MarketPayNotificationService-v5.json b/json/MarketPayNotificationService-v5.json index 03c5fd3..95b5157 100644 --- a/json/MarketPayNotificationService-v5.json +++ b/json/MarketPayNotificationService-v5.json @@ -22,6 +22,9 @@ "webhooks" : { "/ACCOUNT_CLOSED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the closure of an account.", "description" : "This notification is sent when an account has been closed.", "operationId" : "post-ACCOUNT_CLOSED", @@ -72,6 +75,9 @@ }, "/ACCOUNT_CREATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the creation of an account.", "description" : "This notification is sent when an account has been created.", "operationId" : "post-ACCOUNT_CREATED", @@ -112,6 +118,9 @@ }, "/ACCOUNT_FUNDS_BELOW_THRESHOLD" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when a liable account current funds are below configured threshold.", "description" : "This notification is sent when a liable account's current funds are below configured threshold from the Adyen platform.", "operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD", @@ -152,6 +161,9 @@ }, "/ACCOUNT_HOLDER_CREATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the creation of an account holder.", "description" : "This notification is sent when an account holder has been created.", "operationId" : "post-ACCOUNT_HOLDER_CREATED", @@ -192,6 +204,9 @@ }, "/ACCOUNT_HOLDER_PAYOUT" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon a payout to an account holder.", "description" : "This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled.", "operationId" : "post-ACCOUNT_HOLDER_PAYOUT", @@ -232,6 +247,9 @@ }, "/ACCOUNT_HOLDER_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of an account holder.", "description" : "This notification is sent when the status of an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE", @@ -272,6 +290,9 @@ }, "/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of a store tied to an account holder.", "description" : "This notification is sent when the status of a store tied to an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE", @@ -312,6 +333,9 @@ }, "/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon an upcoming deadline.", "description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.", "operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE", @@ -352,6 +376,9 @@ }, "/ACCOUNT_HOLDER_UPDATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the update of an account holder.", "description" : "This notification is sent when an account holder has been updated.", "operationId" : "post-ACCOUNT_HOLDER_UPDATED", @@ -392,6 +419,9 @@ }, "/ACCOUNT_HOLDER_VERIFICATION" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the receipt of KYC Verification results.", "description" : "This notification is sent when KYC Verification results are made available.", "operationId" : "post-ACCOUNT_HOLDER_VERIFICATION", @@ -432,6 +462,9 @@ }, "/ACCOUNT_UPDATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the update of an account.", "description" : "This notification is sent when an account has been updated.", "operationId" : "post-ACCOUNT_UPDATED", @@ -472,6 +505,9 @@ }, "/BENEFICIARY_SETUP" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the setup of a beneficiary.", "description" : "This notification is sent when a benefactor/beneficiary relationship between accounts has been set up.", "operationId" : "post-BENEFICIARY_SETUP", @@ -512,6 +548,9 @@ }, "/COMPENSATE_NEGATIVE_BALANCE" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the compensation of negative account balances.", "description" : "This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate for the overdraft.", "operationId" : "post-COMPENSATE_NEGATIVE_BALANCE", @@ -552,6 +591,9 @@ }, "/DIRECT_DEBIT_INITIATED" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when an automated direct debit is initiated.", "description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.", "operationId" : "post-DIRECT_DEBIT_INITIATED", @@ -592,6 +634,9 @@ }, "/PAYMENT_FAILURE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a booking for a capture or refund fails.", "description" : "This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to your platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", @@ -632,6 +677,9 @@ }, "/REFUND_FUNDS_TRANSFER" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer refund of funds between accounts.", "description" : "This notification is sent when the refund of funds from an account have been transferred to another account.", "operationId" : "post-REFUND_FUNDS_TRANSFER", @@ -672,6 +720,9 @@ }, "/REPORT_AVAILABLE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a report is made available.", "description" : "This notification is sent when a report has been made available.", "operationId" : "post-REPORT_AVAILABLE", @@ -712,6 +763,9 @@ }, "/SCHEDULED_REFUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call.", "description" : "This notification is sent when a 'Refund Transfers Not Paid Out' call has been processed and the associated refunds have been scheduled.", "operationId" : "post-SCHEDULED_REFUNDS", @@ -752,6 +806,9 @@ }, "/TRANSFER_FUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer of funds between accounts.", "description" : "This notification is sent when the funds from an account have been transferred to another account.", "operationId" : "post-TRANSFER_FUNDS", @@ -800,12 +857,12 @@ "$ref" : "#/components/schemas/CloseAccountResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -843,12 +900,12 @@ "$ref" : "#/components/schemas/CreateAccountResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -912,12 +969,12 @@ "$ref" : "#/components/schemas/AccountFundsBelowThresholdNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -983,12 +1040,12 @@ "$ref" : "#/components/schemas/CreateAccountHolderResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1033,7 +1090,7 @@ "type" : "array" }, "bankAggregatorDataReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The opaque reference value returned by the Adyen API during bank account login.", "type" : "string" }, @@ -1065,15 +1122,19 @@ "type" : "object" }, "payoutMethods" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, "type" : "array" }, + "principalBusinessAddress" : { + "description" : "The principal business address of the account holder.", + "$ref" : "#/components/schemas/ViasAddress" + }, "storeDetails" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" @@ -1098,12 +1159,12 @@ "$ref" : "#/components/schemas/AccountHolderPayoutNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1164,12 +1225,12 @@ "type" : "string" }, "estimatedArrivalDate" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The estimated date of arrival.", "$ref" : "#/components/schemas/LocalDate" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1177,17 +1238,17 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The merchant reference.", "type" : "string" }, "originalPspReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The PSP reference of the original payout.", "type" : "string" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -1249,12 +1310,12 @@ "$ref" : "#/components/schemas/AccountHolderStatusChangeNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1291,7 +1352,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1299,12 +1360,12 @@ "type" : "array" }, "newStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "oldStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The former status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -1326,12 +1387,12 @@ "$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1364,12 +1425,12 @@ "AccountHolderStoreStatusChangeNotificationContent" : { "properties" : { "accountHolderCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The code of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "In case the store status has not been updated, contains fields that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1377,7 +1438,7 @@ "type" : "array" }, "newStatus" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The new status of the account holder.", "enum" : [ "Active", @@ -1389,7 +1450,7 @@ "type" : "string" }, "oldStatus" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The former status of the account holder.", "enum" : [ "Active", @@ -1401,17 +1462,17 @@ "type" : "string" }, "reason" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The reason for the status change.", "type" : "string" }, "store" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Alphanumeric identifier of the store.", "type" : "string" }, "storeReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Store store reference.", "type" : "string" } @@ -1431,12 +1492,12 @@ "$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1516,12 +1577,12 @@ "$ref" : "#/components/schemas/UpdateAccountHolderResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1559,12 +1620,12 @@ "$ref" : "#/components/schemas/AccountHolderVerificationNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1606,7 +1667,7 @@ "type" : "string" }, "kycCheckStatusData" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information on the verification status", "$ref" : "#/components/schemas/KYCCheckStatusData" }, @@ -1638,7 +1699,7 @@ "type" : "boolean" }, "notAllowedReason" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.", "type" : "string" }, @@ -1647,7 +1708,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1673,7 +1734,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1687,12 +1748,12 @@ "$ref" : "#/components/schemas/UpdateAccountResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1757,7 +1818,7 @@ "type" : "string" }, "bankAccountReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Merchant reference to the bank account.", "type" : "string" }, @@ -1858,12 +1919,12 @@ "$ref" : "#/components/schemas/BeneficiarySetupNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1905,7 +1966,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1948,8 +2009,15 @@ "description" : "The legal name of the company.", "type" : "string" }, + "listedUltimateParentCompany" : { + "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", + "items" : { + "$ref" : "#/components/schemas/UltimateParentCompany" + }, + "type" : "array" + }, "registrationNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The registration number of the company.", "type" : "string" }, @@ -1976,12 +2044,12 @@ "CloseAccountResponse" : { "properties" : { "accountCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account code of the account that is closed.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1997,7 +2065,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -2019,12 +2087,12 @@ "$ref" : "#/components/schemas/CompensateNegativeBalanceNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2105,17 +2173,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the new account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2123,19 +2191,17 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The type of legal entity of the new account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2148,7 +2214,7 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -2172,17 +2238,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2190,7 +2256,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2198,7 +2264,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2207,7 +2273,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -2225,7 +2291,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -2249,12 +2315,12 @@ "$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2443,6 +2509,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -2463,6 +2530,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -2612,13 +2680,13 @@ "KYCCheckSummary" : { "properties" : { "kycCheckCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes).", "format" : "int32", "type" : "integer" }, "kycCheckDescription" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A description of the check.", "type" : "string" } @@ -2668,7 +2736,7 @@ "type" : "array" }, "cards" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The results of the checks on the cards.", "items" : { "$ref" : "#/components/schemas/KYCCardCheckResult" @@ -2754,12 +2822,12 @@ "$ref" : "#/components/schemas/PaymentFailureNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2929,12 +2997,12 @@ "$ref" : "#/components/schemas/RefundFundsTransferNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2972,7 +3040,7 @@ "$ref" : "#/components/schemas/Amount" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3024,12 +3092,12 @@ "$ref" : "#/components/schemas/ReportAvailableNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3092,12 +3160,12 @@ "$ref" : "#/components/schemas/ScheduledRefundsNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3139,7 +3207,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3199,7 +3267,7 @@ "type" : "string" }, "shareholderReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Your reference for the shareholder entry.", "type" : "string" }, @@ -3341,7 +3409,7 @@ "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shopperInteraction" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", "enum" : [ "Ecommerce", @@ -3350,7 +3418,7 @@ "type" : "string" }, "splitConfigurationUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", "type" : "string" }, @@ -3379,12 +3447,12 @@ "type" : "string" }, "virtualAccount" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", "type" : "string" }, "webAddress" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "URL of the ecommerce store.", "type" : "string" } @@ -3440,12 +3508,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -3517,12 +3585,12 @@ "$ref" : "#/components/schemas/TransferFundsNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3564,7 +3632,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3572,7 +3640,7 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The reference provided by the merchant.", "type" : "string" }, @@ -3596,6 +3664,46 @@ "transferCode" ] }, + "UltimateParentCompany" : { + "properties" : { + "address" : { + "description" : "Address of the ultimate parent company.", + "$ref" : "#/components/schemas/ViasAddress" + }, + "businessDetails" : { + "description" : "Details about the ultimate parent company's business.", + "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" + }, + "ultimateParentCompanyCode" : { + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", + "type" : "string" + } + } + }, + "UltimateParentCompanyBusinessDetails" : { + "properties" : { + "legalBusinessName" : { + "description" : "The legal name of the company.", + "type" : "string" + }, + "registrationNumber" : { + "description" : "The registration number of the company.", + "type" : "string" + }, + "stockExchange" : { + "description" : "Market Identifier Code (MIC).", + "type" : "string" + }, + "stockNumber" : { + "description" : "International Securities Identification Number (ISIN).", + "type" : "string" + }, + "stockTicker" : { + "description" : "Stock Ticker symbol.", + "type" : "string" + } + } + }, "UpdateAccountHolderResponse" : { "properties" : { "accountHolderCode" : { @@ -3607,17 +3715,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3625,19 +3733,17 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The legal entity of the account holder.", "enum" : [ "Business", "Individual", - "NonProfit", - "Partnership", - "PublicCompany" + "NonProfit" ], "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -3650,7 +3756,7 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" } @@ -3668,17 +3774,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/updateAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3686,7 +3792,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -3694,7 +3800,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -3703,7 +3809,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -3793,7 +3899,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" diff --git a/json/MarketPayNotificationService-v6.json b/json/MarketPayNotificationService-v6.json index 57d89ac..5c5bf71 100644 --- a/json/MarketPayNotificationService-v6.json +++ b/json/MarketPayNotificationService-v6.json @@ -22,6 +22,9 @@ "webhooks" : { "/ACCOUNT_CLOSED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the closure of an account.", "description" : "This notification is sent when an account has been closed.", "operationId" : "post-ACCOUNT_CLOSED", @@ -72,6 +75,9 @@ }, "/ACCOUNT_CREATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the creation of an account.", "description" : "This notification is sent when an account has been created.", "operationId" : "post-ACCOUNT_CREATED", @@ -112,6 +118,9 @@ }, "/ACCOUNT_FUNDS_BELOW_THRESHOLD" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when a liable account current funds are below configured threshold.", "description" : "This notification is sent when a liable account's current funds are below configured threshold from the Adyen platform.", "operationId" : "post-ACCOUNT_FUNDS_BELOW_THRESHOLD", @@ -152,6 +161,9 @@ }, "/ACCOUNT_HOLDER_CREATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the creation of an account holder.", "description" : "This notification is sent when an account holder has been created.", "operationId" : "post-ACCOUNT_HOLDER_CREATED", @@ -192,6 +204,9 @@ }, "/ACCOUNT_HOLDER_PAYOUT" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon a payout to an account holder.", "description" : "This notification is sent when a payout request to an account holder has been processed and the payout has been scheduled.", "operationId" : "post-ACCOUNT_HOLDER_PAYOUT", @@ -232,6 +247,9 @@ }, "/ACCOUNT_HOLDER_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of an account holder.", "description" : "This notification is sent when the status of an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STATUS_CHANGE", @@ -272,6 +290,9 @@ }, "/ACCOUNT_HOLDER_STORE_STATUS_CHANGE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the status change of a store tied to an account holder.", "description" : "This notification is sent when the status of a store tied to an account holder has been changed.", "operationId" : "post-ACCOUNT_HOLDER_STORE_STATUS_CHANGE", @@ -312,6 +333,9 @@ }, "/ACCOUNT_HOLDER_UPCOMING_DEADLINE" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon an upcoming deadline.", "description" : "This notification is sent when an Account Holder has a deadline, to fulfill the requirements of a specific event, coming up.", "operationId" : "post-ACCOUNT_HOLDER_UPCOMING_DEADLINE", @@ -352,6 +376,9 @@ }, "/ACCOUNT_HOLDER_UPDATED" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the update of an account holder.", "description" : "This notification is sent when an account holder has been updated.", "operationId" : "post-ACCOUNT_HOLDER_UPDATED", @@ -392,6 +419,9 @@ }, "/ACCOUNT_HOLDER_VERIFICATION" : { "post" : { + "tags" : [ + "Account holders" + ], "summary" : "Triggered upon the receipt of KYC Verification results.", "description" : "This notification is sent when KYC Verification results are made available.", "operationId" : "post-ACCOUNT_HOLDER_VERIFICATION", @@ -432,6 +462,9 @@ }, "/ACCOUNT_UPDATED" : { "post" : { + "tags" : [ + "Accounts" + ], "summary" : "Triggered upon the update of an account.", "description" : "This notification is sent when an account has been updated.", "operationId" : "post-ACCOUNT_UPDATED", @@ -472,6 +505,9 @@ }, "/BENEFICIARY_SETUP" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the setup of a beneficiary.", "description" : "This notification is sent when a benefactor/beneficiary relationship between accounts has been set up.", "operationId" : "post-BENEFICIARY_SETUP", @@ -512,6 +548,9 @@ }, "/COMPENSATE_NEGATIVE_BALANCE" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the compensation of negative account balances.", "description" : "This notification is sent when funds have been transferred from your platform's liable account to an overdrawn account in order to compensate for the overdraft.", "operationId" : "post-COMPENSATE_NEGATIVE_BALANCE", @@ -552,6 +591,9 @@ }, "/DIRECT_DEBIT_INITIATED" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered when an automated direct debit is initiated.", "description" : "This notification is sent when an automated direct debit is initiated from the Adyen platform.", "operationId" : "post-DIRECT_DEBIT_INITIATED", @@ -592,6 +634,9 @@ }, "/PAYMENT_FAILURE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a booking for a capture or refund fails.", "description" : "This notification is sent when a [split payment](https://docs.adyen.com/platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to your platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", @@ -632,6 +677,9 @@ }, "/REFUND_FUNDS_TRANSFER" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer refund of funds between accounts.", "description" : "This notification is sent when the refund of funds from an account have been transferred to another account.", "operationId" : "post-REFUND_FUNDS_TRANSFER", @@ -672,6 +720,9 @@ }, "/REPORT_AVAILABLE" : { "post" : { + "tags" : [ + "Other" + ], "summary" : "Triggered when a report is made available.", "description" : "This notification is sent when a report has been made available.", "operationId" : "post-REPORT_AVAILABLE", @@ -712,6 +763,9 @@ }, "/SCHEDULED_REFUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the scheduling of refunds requested by a 'Refund Transfers Not Paid Out' call.", "description" : "This notification is sent when a 'Refund Transfers Not Paid Out' call has been processed and the associated refunds have been scheduled.", "operationId" : "post-SCHEDULED_REFUNDS", @@ -752,6 +806,9 @@ }, "/TRANSFER_FUNDS" : { "post" : { + "tags" : [ + "Fund management" + ], "summary" : "Triggered upon the transfer of funds between accounts.", "description" : "This notification is sent when the funds from an account have been transferred to another account.", "operationId" : "post-TRANSFER_FUNDS", @@ -800,12 +857,12 @@ "$ref" : "#/components/schemas/CloseAccountResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -843,12 +900,12 @@ "$ref" : "#/components/schemas/CreateAccountResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -912,12 +969,12 @@ "$ref" : "#/components/schemas/AccountFundsBelowThresholdNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -983,12 +1040,12 @@ "$ref" : "#/components/schemas/CreateAccountHolderResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1033,7 +1090,7 @@ "type" : "array" }, "bankAggregatorDataReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The opaque reference value returned by the Adyen API during bank account login.", "type" : "string" }, @@ -1054,8 +1111,8 @@ "$ref" : "#/components/schemas/IndividualDetails" }, "legalArrangements" : { - "x-addedInVersion" : 6, - "description" : "Array that contains information about legal arrangements, used when the account holder is acting on behalf of different parties or is part of a contractual business agreement.", + "x-addedInVersion" : "6", + "description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/platforms/verification-checks/legal-arrangements).", "items" : { "$ref" : "#/components/schemas/LegalArrangementDetail" }, @@ -1073,7 +1130,7 @@ "type" : "object" }, "payoutMethods" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" @@ -1081,12 +1138,11 @@ "type" : "array" }, "principalBusinessAddress" : { - "x-addedInVersion" : 6, - "description" : "The prinicipal business address of the account holder.", + "description" : "The principal business address of the account holder.", "$ref" : "#/components/schemas/ViasAddress" }, "storeDetails" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" @@ -1111,12 +1167,12 @@ "$ref" : "#/components/schemas/AccountHolderPayoutNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1173,12 +1229,12 @@ "type" : "string" }, "estimatedArrivalDate" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The estimated date of arrival.", "$ref" : "#/components/schemas/LocalDate" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1186,43 +1242,43 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The merchant reference.", "type" : "string" }, "originalPspReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The PSP reference of the original payout.", "type" : "string" }, "payoutAccountCountry" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Payout account country.", "type" : "string" }, "payoutAccountNumber" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Payout bank account number.", "type" : "string" }, "payoutBankName" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Payout bank name.", "type" : "string" }, "payoutBranchCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Payout branch code.", "type" : "string" }, "payoutReference" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Payout transaction id.", "format" : "int64", "type" : "integer" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -1284,12 +1340,12 @@ "$ref" : "#/components/schemas/AccountHolderStatusChangeNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1326,7 +1382,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1334,12 +1390,12 @@ "type" : "array" }, "newStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "oldStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The former status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, @@ -1361,12 +1417,12 @@ "$ref" : "#/components/schemas/AccountHolderStoreStatusChangeNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1399,12 +1455,12 @@ "AccountHolderStoreStatusChangeNotificationContent" : { "properties" : { "accountHolderCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The code of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "In case the store status has not been updated, contains fields that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1412,7 +1468,7 @@ "type" : "array" }, "newStatus" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The new status of the account holder.", "enum" : [ "Active", @@ -1424,7 +1480,7 @@ "type" : "string" }, "oldStatus" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The former status of the account holder.", "enum" : [ "Active", @@ -1436,17 +1492,17 @@ "type" : "string" }, "reason" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The reason for the status change.", "type" : "string" }, "store" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Alphanumeric identifier of the store.", "type" : "string" }, "storeReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Store store reference.", "type" : "string" } @@ -1466,12 +1522,12 @@ "$ref" : "#/components/schemas/AccountHolderUpcomingDeadlineNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1551,12 +1607,12 @@ "$ref" : "#/components/schemas/UpdateAccountHolderResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1594,12 +1650,12 @@ "$ref" : "#/components/schemas/AccountHolderVerificationNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1637,22 +1693,22 @@ "type" : "string" }, "kycCheckStatusData" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Information on the verification status", "$ref" : "#/components/schemas/KYCCheckStatusData" }, "legalArrangementCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique ID of the legal arrangement that has been verified.", "type" : "string" }, "legalArrangementEntityCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique ID of the legal arrangement entity that has been verified.", "type" : "string" }, "payoutMethodCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique code of the payout method that has been verified.", "type" : "string" }, @@ -1684,7 +1740,7 @@ "type" : "boolean" }, "notAllowedReason" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.", "type" : "string" }, @@ -1693,7 +1749,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The payout tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1719,7 +1775,7 @@ "$ref" : "#/components/schemas/Amount" }, "tierNumber" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The processing tier that the account holder occupies.", "format" : "int32", "type" : "integer" @@ -1733,12 +1789,12 @@ "$ref" : "#/components/schemas/UpdateAccountResponse" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1803,7 +1859,7 @@ "type" : "string" }, "bankAccountReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Merchant reference to the bank account.", "type" : "string" }, @@ -1904,12 +1960,12 @@ "$ref" : "#/components/schemas/BeneficiarySetupNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -1951,7 +2007,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A listing of the invalid fields which have caused the Setup Beneficiary request to fail. If this is empty, the Setup Beneficiary request has succeeded.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1995,7 +2051,6 @@ "type" : "string" }, "listedUltimateParentCompany" : { - "x-addedInVersion" : 6, "description" : "Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.", "items" : { "$ref" : "#/components/schemas/UltimateParentCompany" @@ -2003,7 +2058,7 @@ "type" : "array" }, "registrationNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The registration number of the company.", "type" : "string" }, @@ -2022,17 +2077,17 @@ "type" : "array" }, "stockExchange" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Market Identifier Code (MIC).", "type" : "string" }, "stockNumber" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "International Securities Identification Number (ISIN).", "type" : "string" }, "stockTicker" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "Stock Ticker symbol.", "type" : "string" }, @@ -2045,12 +2100,12 @@ "CloseAccountResponse" : { "properties" : { "accountCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account code of the account that is closed.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2066,7 +2121,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.", "enum" : [ "Active", @@ -2088,12 +2143,12 @@ "$ref" : "#/components/schemas/CompensateNegativeBalanceNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2174,17 +2229,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the new account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the new account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccountHolder` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2192,7 +2247,7 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The type of legal entity of the new account holder.", "enum" : [ "Business", @@ -2204,7 +2259,7 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2217,12 +2272,12 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -2246,17 +2301,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/createAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -2264,7 +2319,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -2272,7 +2327,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -2281,7 +2336,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -2299,7 +2354,7 @@ "type" : "string" }, "status" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The status of the account.\n>Permitted values: `Active`.", "enum" : [ "Active", @@ -2323,12 +2378,12 @@ "$ref" : "#/components/schemas/DirectDebitInitiatedNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -2517,6 +2572,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -2537,6 +2593,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -2656,13 +2713,13 @@ "KYCCheckSummary" : { "properties" : { "kycCheckCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes).", "format" : "int32", "type" : "integer" }, "kycCheckDescription" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A description of the check.", "type" : "string" } @@ -2727,12 +2784,12 @@ "type" : "array" }, "legalArrangementCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique ID of the legal arrangement to which the shareholder belongs, if applicable.", "type" : "string" }, "legalArrangementEntityCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable.", "type" : "string" }, @@ -2767,7 +2824,7 @@ "type" : "array" }, "ultimateParentCompanyCode" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The code of the Ultimate Parent Company to which the check applies.", "type" : "string" } @@ -2780,7 +2837,7 @@ "$ref" : "#/components/schemas/KYCCheckResult2" }, "legalArrangements" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The results of the checks on the legal arrangements.", "items" : { "$ref" : "#/components/schemas/KYCLegalArrangementCheckResult" @@ -2788,7 +2845,7 @@ "type" : "array" }, "legalArrangementsEntities" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The results of the checks on the legal arrangement entities.", "items" : { "$ref" : "#/components/schemas/KYCLegalArrangementEntityCheckResult" @@ -2796,7 +2853,7 @@ "type" : "array" }, "payoutMethods" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The results of the checks on the payout methods.", "items" : { "$ref" : "#/components/schemas/KYCPayoutMethodCheckResult" @@ -2818,7 +2875,7 @@ "type" : "array" }, "ultimateParentCompany" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The result of the check on the Ultimate Parent Company.", "items" : { "$ref" : "#/components/schemas/KYCUltimateParentCompanyCheckResult" @@ -2830,7 +2887,7 @@ "LegalArrangementDetail" : { "properties" : { "address" : { - "description" : "The address of the legal arrangement member.", + "description" : "The address of the legal arrangement.", "$ref" : "#/components/schemas/ViasAddress" }, "legalArrangementCode" : { @@ -2838,7 +2895,7 @@ "type" : "string" }, "legalArrangementEntities" : { - "description" : "Array that contains information about the entities or members that are part of the legal arrangement.", + "description" : "An array containing information about other entities that are part of the legal arrangement.", "items" : { "$ref" : "#/components/schemas/LegalArrangementEntityDetail" }, @@ -2849,7 +2906,7 @@ "type" : "string" }, "legalForm" : { - "description" : "The structure of the legal arrangement as defined according to legislations in the country.\n\n Possible values: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, **UnlistedPublicUnitTrust**, **LimitedPartnership**, **FamilyPartnership**, **OtherPartnership**.", + "description" : "The form of legal arrangement. Required if `type` is **Trust** or **Partnership**.\n\nThe possible values depend on the `type`.\n\n- For `type` **Trust**: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**.\n\n- For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, or **OtherPartnership**", "enum" : [ "CashManagementTrust", "CorporateUnitTrust", @@ -2873,7 +2930,7 @@ "type" : "string" }, "name" : { - "description" : "The legal name of the legal arrangement.", + "description" : "The legal name of the legal arrangement. Minimum length: 3 characters.", "type" : "string" }, "registrationNumber" : { @@ -2885,14 +2942,21 @@ "type" : "string" }, "type" : { - "description" : "The type of legal arrangement.\n\nPossible values:\n\n- **Trust** - A legal agreement where the account holder is a trustee that manages assets for beneficiaries.\n- **Partnership** - A legal arrangement where the account holder is a partner that has an agreement with one or more partners to manage, operate and share profits of their jointly-owned business.", + "description" : "The [type of legal arrangement](https://docs.adyen.com/platforms/verification-checks/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n", "enum" : [ + "Association", "Partnership", + "SoleProprietorship", "Trust" ], "type" : "string" } - } + }, + "required" : [ + "type", + "name", + "address" + ] }, "LegalArrangementEntityDetail" : { "properties" : { @@ -2917,7 +2981,7 @@ "$ref" : "#/components/schemas/IndividualDetails" }, "legalArrangementEntityCode" : { - "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity.", + "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. Required when updating an existing legal arrangement entity entry in an `/updateAccountHolder` request.", "type" : "string" }, "legalArrangementEntityReference" : { @@ -2925,18 +2989,15 @@ "type" : "string" }, "legalArrangementMembers" : { - "description" : "The roles of the entity in the legal arrangement. The values depend on the `legalArragementType`.\n\nPossible values:\n\n- For `legalArragementType` **Trust**, you can use **Trustee**, **Settlor**, **Protector**, **Beneficiary**, or **Shareholder**.\n\n- For `legalArragementType` **Partnership**, you can use **Partner** or **Shareholder**. ", + "description" : "An array containing the roles of the entity in the legal arrangement.\n\nThe possible values depend on the legal arrangement `type`.\n\n- For `type` **Association**: **ControllingPerson** and **Shareholder**.\n\n- For `type` **Partnership**: **Partner** and **Shareholder**.\n\n- For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**, and **Shareholder**.\n\n", "items" : { "enum" : [ - "Associate", "Beneficiary", - "Chairman", + "ControllingPerson", "Partner", "Protector", - "Secretary", "Settlor", "Shareholder", - "Treasurer", "Trustee" ], "type" : "string" @@ -3030,12 +3091,12 @@ "$ref" : "#/components/schemas/PaymentFailureNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3205,12 +3266,12 @@ "$ref" : "#/components/schemas/RefundFundsTransferNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3248,7 +3309,7 @@ "$ref" : "#/components/schemas/Amount" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3300,12 +3361,12 @@ "$ref" : "#/components/schemas/ReportAvailableNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3368,12 +3429,12 @@ "$ref" : "#/components/schemas/ScheduledRefundsNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3415,7 +3476,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3475,7 +3536,7 @@ "type" : "string" }, "shareholderReference" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Your reference for the shareholder entry.", "type" : "string" }, @@ -3617,7 +3678,7 @@ "$ref" : "#/components/schemas/ViasPhoneNumber" }, "shopperInteraction" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The sales channel. Possible values: **Ecommerce**, **POS**.", "enum" : [ "Ecommerce", @@ -3626,7 +3687,7 @@ "type" : "string" }, "splitConfigurationUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.", "type" : "string" }, @@ -3655,12 +3716,12 @@ "type" : "string" }, "virtualAccount" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.", "type" : "string" }, "webAddress" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "URL of the ecommerce store.", "type" : "string" } @@ -3716,12 +3777,12 @@ "type" : "string" }, "paymentPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related authorisation or transfer.", "type" : "string" }, "payoutPspReference" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "The psp reference of the related payout.", "type" : "string" }, @@ -3793,12 +3854,12 @@ "$ref" : "#/components/schemas/TransferFundsNotificationContent" }, "error" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Error information of failed request. No value provided here if no error occurred on processing.", "$ref" : "#/components/schemas/NotificationErrorContainer" }, "eventDate" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The date and time when an event has been completed.", "format" : "date-time", "type" : "string" @@ -3840,7 +3901,7 @@ "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Invalid fields list.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3848,7 +3909,7 @@ "type" : "array" }, "merchantReference" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The reference provided by the merchant.", "type" : "string" }, @@ -3875,17 +3936,14 @@ "UltimateParentCompany" : { "properties" : { "address" : { - "x-addedInVersion" : 6, "description" : "Address of the ultimate parent company.", "$ref" : "#/components/schemas/ViasAddress" }, "businessDetails" : { - "x-addedInVersion" : 6, "description" : "Details about the ultimate parent company's business.", "$ref" : "#/components/schemas/UltimateParentCompanyBusinessDetails" }, "ultimateParentCompanyCode" : { - "x-addedInVersion" : 6, "description" : "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.", "type" : "string" } @@ -3898,22 +3956,18 @@ "type" : "string" }, "registrationNumber" : { - "x-addedInVersion" : 4, "description" : "The registration number of the company.", "type" : "string" }, "stockExchange" : { - "x-addedInVersion" : 6, "description" : "Market Identifier Code (MIC).", "type" : "string" }, "stockNumber" : { - "x-addedInVersion" : 6, "description" : "International Securities Identification Number (ISIN).", "type" : "string" }, "stockTicker" : { - "x-addedInVersion" : 6, "description" : "Stock Ticker symbol.", "type" : "string" } @@ -3930,17 +3984,17 @@ "$ref" : "#/components/schemas/AccountHolderDetails" }, "accountHolderStatus" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The new status of the account holder.", "$ref" : "#/components/schemas/AccountHolderStatus" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account holder.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "in case the account holder has not been updated, contains account holder fields, that did not pass the validation.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -3948,7 +4002,7 @@ "type" : "array" }, "legalEntity" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The legal entity of the account holder.", "enum" : [ "Business", @@ -3960,7 +4014,7 @@ "type" : "string" }, "primaryCurrency" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -3973,12 +4027,12 @@ "type" : "string" }, "verification" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The details of KYC Verification of the account holder.", "$ref" : "#/components/schemas/KYCVerificationResult2" }, "verificationProfile" : { - "x-addedInVersion" : 6, + "x-addedInVersion" : "6", "description" : "The identifier of the profile that applies to this entity.", "type" : "string" } @@ -3996,17 +4050,17 @@ "type" : "string" }, "bankAccountUUID" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.", "type" : "string" }, "description" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The description of the account.", "type" : "string" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A list of fields that caused the `/updateAccount` request to fail.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -4014,7 +4068,7 @@ "type" : "array" }, "metadata" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -4022,7 +4076,7 @@ "type" : "object" }, "payoutMethodCode" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.", "type" : "string" }, @@ -4031,7 +4085,7 @@ "$ref" : "#/components/schemas/PayoutScheduleResponse" }, "payoutSpeed" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.", "enum" : [ "INSTANT", @@ -4121,7 +4175,7 @@ "type" : "string" }, "documentData" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Array that contains information about the person's identification document. You can submit only one entry per document type.", "items" : { "$ref" : "#/components/schemas/PersonalDocumentData" diff --git a/json/NotificationConfigurationService-v1.json b/json/NotificationConfigurationService-v1.json index 8e03948..621c254 100644 --- a/json/NotificationConfigurationService-v1.json +++ b/json/NotificationConfigurationService-v1.json @@ -23,6 +23,9 @@ "paths" : { "/createNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Subscribe to notifications.", "description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.", "operationId" : "post-createNotificationConfiguration", @@ -57,8 +60,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-createNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" } }, "schema" : { @@ -123,6 +126,9 @@ }, "/deleteNotificationConfigurations" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Delete an existing notification subscription configuration.", "description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.", "operationId" : "post-deleteNotificationConfigurations", @@ -213,6 +219,9 @@ }, "/getNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve an existing notification subscription configuration.", "description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.", "operationId" : "post-getNotificationConfiguration", @@ -303,6 +312,9 @@ }, "/getNotificationConfigurationList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of existing notification subscription configurations.", "description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.", "operationId" : "post-getNotificationConfigurationList", @@ -393,6 +405,9 @@ }, "/testNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Test an existing notification configuration.", "description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.", "operationId" : "post-testNotificationConfiguration", @@ -483,6 +498,9 @@ }, "/updateNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Update an existing notification subscription configuration.", "description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.", "operationId" : "post-updateNotificationConfiguration", @@ -517,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" } }, "schema" : { @@ -716,7 +734,7 @@ "type" : "string" }, "eventConfigs" : { - "description" : "The types of events whose notifications apply to this configuration.", + "description" : "Contains objects that define event types and their subscription settings.", "items" : { "$ref" : "#/components/schemas/NotificationEventConfiguration" }, @@ -732,7 +750,7 @@ "type" : "string" }, "notificationId" : { - "description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.", + "description" : "Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).", "format" : "int64", "type" : "integer" }, @@ -775,7 +793,7 @@ "NotificationEventConfiguration" : { "properties" : { "eventType" : { - "description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.", + "description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.", "enum" : [ "ACCOUNT_CLOSED", "ACCOUNT_CREATED", @@ -802,7 +820,7 @@ "type" : "string" }, "includeMode" : { - "description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).", + "description" : "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum" : [ "EXCLUDE", "INCLUDE" @@ -1007,30 +1025,6 @@ } } }, - "post-createNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178952143018", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "true", - "description" : "Test notification769551", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_VERIFICATION", - "includeMode" : "INCLUDE" - } - } - ], - "messageFormat" : "SOAP", - "notificationId" : 28467, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sendActionHeader" : "true", - "sslProtocol" : "SSLInsecureCiphers" - } - } - }, "post-updateNotificationConfiguration-basic" : { "summary" : "Update notification configurations", "value" : { @@ -1059,36 +1053,6 @@ "sslProtocol" : "TLSv10" } } - }, - "post-updateNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178951636344", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "false", - "description" : "new description799847", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_CREATED", - "includeMode" : "INCLUDE" - } - }, - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_CREATED", - "includeMode" : "EXCLUDE" - } - } - ], - "messageFormat" : "JSON", - "notificationId" : 21259, - "notifyURL" : "http://www.adyen.com", - "sendActionHeader" : "false", - "sslProtocol" : "TLSv10" - } - } } } } diff --git a/json/NotificationConfigurationService-v2.json b/json/NotificationConfigurationService-v2.json index f395252..f800d96 100644 --- a/json/NotificationConfigurationService-v2.json +++ b/json/NotificationConfigurationService-v2.json @@ -23,6 +23,9 @@ "paths" : { "/createNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Subscribe to notifications.", "description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.", "operationId" : "post-createNotificationConfiguration", @@ -57,8 +60,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-createNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" } }, "schema" : { @@ -123,6 +126,9 @@ }, "/deleteNotificationConfigurations" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Delete an existing notification subscription configuration.", "description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.", "operationId" : "post-deleteNotificationConfigurations", @@ -213,6 +219,9 @@ }, "/getNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve an existing notification subscription configuration.", "description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.", "operationId" : "post-getNotificationConfiguration", @@ -303,6 +312,9 @@ }, "/getNotificationConfigurationList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of existing notification subscription configurations.", "description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.", "operationId" : "post-getNotificationConfigurationList", @@ -393,6 +405,9 @@ }, "/testNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Test an existing notification configuration.", "description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.", "operationId" : "post-testNotificationConfiguration", @@ -483,6 +498,9 @@ }, "/updateNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Update an existing notification subscription configuration.", "description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.", "operationId" : "post-updateNotificationConfiguration", @@ -517,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" } }, "schema" : { @@ -716,7 +734,7 @@ "type" : "string" }, "eventConfigs" : { - "description" : "The types of events whose notifications apply to this configuration.", + "description" : "Contains objects that define event types and their subscription settings.", "items" : { "$ref" : "#/components/schemas/NotificationEventConfiguration" }, @@ -732,7 +750,7 @@ "type" : "string" }, "notificationId" : { - "description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.", + "description" : "Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).", "format" : "int64", "type" : "integer" }, @@ -775,7 +793,7 @@ "NotificationEventConfiguration" : { "properties" : { "eventType" : { - "description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.", + "description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.", "enum" : [ "ACCOUNT_CLOSED", "ACCOUNT_CREATED", @@ -802,7 +820,7 @@ "type" : "string" }, "includeMode" : { - "description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).", + "description" : "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum" : [ "EXCLUDE", "INCLUDE" @@ -1007,30 +1025,6 @@ } } }, - "post-createNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178952143018", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "true", - "description" : "Test notification769551", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_VERIFICATION", - "includeMode" : "INCLUDE" - } - } - ], - "messageFormat" : "SOAP", - "notificationId" : 28467, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sendActionHeader" : "true", - "sslProtocol" : "SSLInsecureCiphers" - } - } - }, "post-updateNotificationConfiguration-basic" : { "summary" : "Update notification configurations", "value" : { @@ -1059,36 +1053,6 @@ "sslProtocol" : "TLSv10" } } - }, - "post-updateNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178951636344", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "false", - "description" : "new description799847", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_CREATED", - "includeMode" : "INCLUDE" - } - }, - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_CREATED", - "includeMode" : "EXCLUDE" - } - } - ], - "messageFormat" : "JSON", - "notificationId" : 21259, - "notifyURL" : "http://www.adyen.com", - "sendActionHeader" : "false", - "sslProtocol" : "TLSv10" - } - } } } } diff --git a/json/NotificationConfigurationService-v3.json b/json/NotificationConfigurationService-v3.json index 7bb2de9..3a67f23 100644 --- a/json/NotificationConfigurationService-v3.json +++ b/json/NotificationConfigurationService-v3.json @@ -23,6 +23,9 @@ "paths" : { "/createNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Subscribe to notifications.", "description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.", "operationId" : "post-createNotificationConfiguration", @@ -57,8 +60,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-createNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" } }, "schema" : { @@ -123,6 +126,9 @@ }, "/deleteNotificationConfigurations" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Delete an existing notification subscription configuration.", "description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.", "operationId" : "post-deleteNotificationConfigurations", @@ -213,6 +219,9 @@ }, "/getNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve an existing notification subscription configuration.", "description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.", "operationId" : "post-getNotificationConfiguration", @@ -303,6 +312,9 @@ }, "/getNotificationConfigurationList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of existing notification subscription configurations.", "description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.", "operationId" : "post-getNotificationConfigurationList", @@ -393,6 +405,9 @@ }, "/testNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Test an existing notification configuration.", "description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.", "operationId" : "post-testNotificationConfiguration", @@ -483,6 +498,9 @@ }, "/updateNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Update an existing notification subscription configuration.", "description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.", "operationId" : "post-updateNotificationConfiguration", @@ -517,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" } }, "schema" : { @@ -716,7 +734,7 @@ "type" : "string" }, "eventConfigs" : { - "description" : "The types of events whose notifications apply to this configuration.", + "description" : "Contains objects that define event types and their subscription settings.", "items" : { "$ref" : "#/components/schemas/NotificationEventConfiguration" }, @@ -732,7 +750,7 @@ "type" : "string" }, "notificationId" : { - "description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.", + "description" : "Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).", "format" : "int64", "type" : "integer" }, @@ -775,7 +793,7 @@ "NotificationEventConfiguration" : { "properties" : { "eventType" : { - "description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.", + "description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.", "enum" : [ "ACCOUNT_CLOSED", "ACCOUNT_CREATED", @@ -802,7 +820,7 @@ "type" : "string" }, "includeMode" : { - "description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).", + "description" : "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum" : [ "EXCLUDE", "INCLUDE" @@ -1007,30 +1025,6 @@ } } }, - "post-createNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178952143018", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "true", - "description" : "Test notification769551", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_VERIFICATION", - "includeMode" : "INCLUDE" - } - } - ], - "messageFormat" : "SOAP", - "notificationId" : 28467, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sendActionHeader" : "true", - "sslProtocol" : "SSLInsecureCiphers" - } - } - }, "post-updateNotificationConfiguration-basic" : { "summary" : "Update notification configurations", "value" : { @@ -1059,36 +1053,6 @@ "sslProtocol" : "TLSv10" } } - }, - "post-updateNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178951636344", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "false", - "description" : "new description799847", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_CREATED", - "includeMode" : "INCLUDE" - } - }, - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_CREATED", - "includeMode" : "EXCLUDE" - } - } - ], - "messageFormat" : "JSON", - "notificationId" : 21259, - "notifyURL" : "http://www.adyen.com", - "sendActionHeader" : "false", - "sslProtocol" : "TLSv10" - } - } } } } diff --git a/json/NotificationConfigurationService-v4.json b/json/NotificationConfigurationService-v4.json index b3f2a6e..aa03cc8 100644 --- a/json/NotificationConfigurationService-v4.json +++ b/json/NotificationConfigurationService-v4.json @@ -23,6 +23,9 @@ "paths" : { "/createNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Subscribe to notifications.", "description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.", "operationId" : "post-createNotificationConfiguration", @@ -57,8 +60,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-createNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" } }, "schema" : { @@ -123,6 +126,9 @@ }, "/deleteNotificationConfigurations" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Delete an existing notification subscription configuration.", "description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.", "operationId" : "post-deleteNotificationConfigurations", @@ -213,6 +219,9 @@ }, "/getNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve an existing notification subscription configuration.", "description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.", "operationId" : "post-getNotificationConfiguration", @@ -303,6 +312,9 @@ }, "/getNotificationConfigurationList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of existing notification subscription configurations.", "description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.", "operationId" : "post-getNotificationConfigurationList", @@ -393,6 +405,9 @@ }, "/testNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Test an existing notification configuration.", "description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.", "operationId" : "post-testNotificationConfiguration", @@ -483,6 +498,9 @@ }, "/updateNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Update an existing notification subscription configuration.", "description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.", "operationId" : "post-updateNotificationConfiguration", @@ -517,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" } }, "schema" : { @@ -716,7 +734,7 @@ "type" : "string" }, "eventConfigs" : { - "description" : "The types of events whose notifications apply to this configuration.", + "description" : "Contains objects that define event types and their subscription settings.", "items" : { "$ref" : "#/components/schemas/NotificationEventConfiguration" }, @@ -732,7 +750,7 @@ "type" : "string" }, "notificationId" : { - "description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.", + "description" : "Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).", "format" : "int64", "type" : "integer" }, @@ -775,7 +793,7 @@ "NotificationEventConfiguration" : { "properties" : { "eventType" : { - "description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.", + "description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.", "enum" : [ "ACCOUNT_CLOSED", "ACCOUNT_CREATED", @@ -802,7 +820,7 @@ "type" : "string" }, "includeMode" : { - "description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).", + "description" : "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum" : [ "EXCLUDE", "INCLUDE" @@ -1007,30 +1025,6 @@ } } }, - "post-createNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8616178952143018", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "true", - "description" : "Test notification769551", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_VERIFICATION", - "includeMode" : "INCLUDE" - } - } - ], - "messageFormat" : "SOAP", - "notificationId" : 28467, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sendActionHeader" : "true", - "sslProtocol" : "SSLInsecureCiphers" - } - } - }, "post-updateNotificationConfiguration-basic" : { "summary" : "Update notification configurations", "value" : { @@ -1059,36 +1053,6 @@ "sslProtocol" : "TLSv10" } } - }, - "post-updateNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178951636344", - "submittedAsync" : "false", - "configurationDetails" : { - "active" : "false", - "description" : "new description799847", - "eventConfigs" : [ - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_CREATED", - "includeMode" : "INCLUDE" - } - }, - { - "NotificationEventConfiguration" : { - "eventType" : "ACCOUNT_HOLDER_CREATED", - "includeMode" : "EXCLUDE" - } - } - ], - "messageFormat" : "JSON", - "notificationId" : 21259, - "notifyURL" : "http://www.adyen.com", - "sendActionHeader" : "false", - "sslProtocol" : "TLSv10" - } - } } } } diff --git a/json/NotificationConfigurationService-v5.json b/json/NotificationConfigurationService-v5.json index 9e1a5eb..b47c495 100644 --- a/json/NotificationConfigurationService-v5.json +++ b/json/NotificationConfigurationService-v5.json @@ -23,6 +23,9 @@ "paths" : { "/createNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Subscribe to notifications.", "description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.", "operationId" : "post-createNotificationConfiguration", @@ -57,8 +60,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-createNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" } }, "schema" : { @@ -123,6 +126,9 @@ }, "/deleteNotificationConfigurations" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Delete an existing notification subscription configuration.", "description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.", "operationId" : "post-deleteNotificationConfigurations", @@ -213,6 +219,9 @@ }, "/getNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve an existing notification subscription configuration.", "description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.", "operationId" : "post-getNotificationConfiguration", @@ -303,6 +312,9 @@ }, "/getNotificationConfigurationList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of existing notification subscription configurations.", "description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.", "operationId" : "post-getNotificationConfigurationList", @@ -393,6 +405,9 @@ }, "/testNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Test an existing notification configuration.", "description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.", "operationId" : "post-testNotificationConfiguration", @@ -483,6 +498,9 @@ }, "/updateNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Update an existing notification subscription configuration.", "description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.", "operationId" : "post-updateNotificationConfiguration", @@ -517,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" } }, "schema" : { @@ -739,6 +757,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -759,6 +778,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -806,7 +826,7 @@ "GenericResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -833,7 +853,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -872,7 +892,7 @@ "$ref" : "#/components/schemas/NotificationConfigurationDetails" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -908,19 +928,19 @@ "type" : "string" }, "eventConfigs" : { - "description" : "The types of events whose notifications apply to this configuration.", + "description" : "Contains objects that define event types and their subscription settings.", "items" : { "$ref" : "#/components/schemas/NotificationEventConfiguration" }, "type" : "array" }, "hmacSignatureKey" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted.\n\n>Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\").\n\nThe omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).", "type" : "string" }, "notificationId" : { - "description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.", + "description" : "Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).", "format" : "int64", "type" : "integer" }, @@ -958,7 +978,7 @@ "NotificationEventConfiguration" : { "properties" : { "eventType" : { - "description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.", + "description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.", "enum" : [ "ACCOUNT_CLOSED", "ACCOUNT_CREATED", @@ -985,7 +1005,7 @@ "type" : "string" }, "includeMode" : { - "description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).", + "description" : "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum" : [ "EXCLUDE", "INCLUDE" @@ -1112,7 +1132,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1190,25 +1210,6 @@ } } }, - "post-createNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178952380553", - "configurationDetails" : { - "active" : true, - "description" : "Unique description 123", - "eventConfigs" : [ - { - "eventType" : "ACCOUNT_HOLDER_VERIFICATION", - "includeMode" : "INCLUDE" - } - ], - "notificationId" : 28468, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sslProtocol" : "SSLInsecureCiphers" - } - } - }, "post-updateNotificationConfiguration-basic" : { "summary" : "Update notification configurations", "value" : { @@ -1232,29 +1233,6 @@ "sslProtocol" : "TLSv10" } } - }, - "post-updateNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178952580574", - "configurationDetails" : { - "active" : false, - "description" : "Test notif config 756", - "eventConfigs" : [ - { - "eventType" : "ACCOUNT_CREATED", - "includeMode" : "INCLUDE" - }, - { - "eventType" : "ACCOUNT_HOLDER_CREATED", - "includeMode" : "EXCLUDE" - } - ], - "notificationId" : 21259, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sslProtocol" : "TLSv10" - } - } } } } diff --git a/json/NotificationConfigurationService-v6.json b/json/NotificationConfigurationService-v6.json index 4707b59..5582020 100644 --- a/json/NotificationConfigurationService-v6.json +++ b/json/NotificationConfigurationService-v6.json @@ -23,6 +23,9 @@ "paths" : { "/createNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Subscribe to notifications.", "description" : "Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.", "operationId" : "post-createNotificationConfiguration", @@ -57,8 +60,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-createNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" } }, "schema" : { @@ -123,6 +126,9 @@ }, "/deleteNotificationConfigurations" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Delete an existing notification subscription configuration.", "description" : "This endpoint is used to delete an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL that was in the subscription.", "operationId" : "post-deleteNotificationConfigurations", @@ -213,6 +219,9 @@ }, "/getNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve an existing notification subscription configuration.", "description" : "This endpoint is used to retrieve the details of the configuration of a notification subscription.", "operationId" : "post-getNotificationConfiguration", @@ -303,6 +312,9 @@ }, "/getNotificationConfigurationList" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieve a list of existing notification subscription configurations.", "description" : "This endpoint is used to retrieve the details of the configurations of all of the notification subscriptions in the marketplace of the executing user.", "operationId" : "post-getNotificationConfigurationList", @@ -393,6 +405,9 @@ }, "/testNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Test an existing notification configuration.", "description" : "This endpoint is used to test an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.", "operationId" : "post-testNotificationConfiguration", @@ -483,6 +498,9 @@ }, "/updateNotificationConfiguration" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Update an existing notification subscription configuration.", "description" : "This endpoint is used to update an existing notification subscription configuration. If updating the event types, all event types desired must be provided, otherwise the previous event type configuration will be overwritten.", "operationId" : "post-updateNotificationConfiguration", @@ -517,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "basic-200" : { - "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic-200" + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" } }, "schema" : { @@ -739,6 +757,7 @@ "passport", "passportNumber", "payoutMethodCode", + "payoutSchedule", "personalData", "phoneCountryCode", "phoneNumber", @@ -759,6 +778,7 @@ "socialSecurityNumber", "sourceAccountCode", "splitAccount", + "splitConfigurationUUID", "splitCurrency", "splitValue", "splits", @@ -806,7 +826,7 @@ "GenericResponse" : { "properties" : { "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -833,7 +853,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -872,7 +892,7 @@ "$ref" : "#/components/schemas/NotificationConfigurationDetails" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -908,19 +928,19 @@ "type" : "string" }, "eventConfigs" : { - "description" : "The types of events whose notifications apply to this configuration.", + "description" : "Contains objects that define event types and their subscription settings.", "items" : { "$ref" : "#/components/schemas/NotificationEventConfiguration" }, "type" : "array" }, "hmacSignatureKey" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted.\n\n>Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\").\n\nThe omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).", "type" : "string" }, "notificationId" : { - "description" : "The ID of the configuration.\n>Required if updating an existing configuration, ignored during the creation of a configuration.", + "description" : "Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).", "format" : "int64", "type" : "integer" }, @@ -958,7 +978,7 @@ "NotificationEventConfiguration" : { "properties" : { "eventType" : { - "description" : "The type of event triggering the notification.\n>Permitted values: `ACCOUNT_HOLDER_CREATED`, `ACCOUNT_CREATED`, `ACCOUNT_UPDATED`, `ACCOUNT_HOLDER_UPDATED`, `ACCOUNT_HOLDER_STATUS_CHANGE`, `ACCOUNT_HOLDER_STORE_STATUS_CHANGE`, `ACCOUNT_HOLDER_VERIFICATION`, `ACCOUNT_HOLDER_LIMIT_REACHED`, `ACCOUNT_HOLDER_PAYOUT`, `PAYMENT_FAILURE`, `SCHEDULED_REFUNDS`, `REPORT_AVAILABLE`, `TRANSFER_FUNDS`, `BENEFICIARY_SETUP`, `COMPENSATE_NEGATIVE_BALANCE`.", + "description" : "The type of event.\n\nPossible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.", "enum" : [ "ACCOUNT_CLOSED", "ACCOUNT_CREATED", @@ -985,7 +1005,7 @@ "type" : "string" }, "includeMode" : { - "description" : "Indicates whether the specified eventType is to be sent to the endpoint or all events other than the specified eventType (and other specified eventTypes) are to be sent.\n>Permitted values: `INCLUDE`, `EXCLUDE`.\n>- `INCLUDE`: send the specified eventType.\n>- `EXCLUDE`: send all eventTypes other than the specified eventType (and other eventTypes marked with `EXCLUDE`).", + "description" : "Indicates whether the specified `eventType` is sent to your webhook endpoint.\nPossible values:\n* **INCLUDE**: Send the specified `eventType`.\n* **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.", "enum" : [ "EXCLUDE", "INCLUDE" @@ -1112,7 +1132,7 @@ "type" : "array" }, "invalidFields" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "description" : "Contains field validation errors that would prevent requests from being processed.", "items" : { "$ref" : "#/components/schemas/ErrorFieldType" @@ -1190,25 +1210,6 @@ } } }, - "post-createNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178952380553", - "configurationDetails" : { - "active" : true, - "description" : "Unique description 123", - "eventConfigs" : [ - { - "eventType" : "ACCOUNT_HOLDER_VERIFICATION", - "includeMode" : "INCLUDE" - } - ], - "notificationId" : 28468, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sslProtocol" : "SSLInsecureCiphers" - } - } - }, "post-updateNotificationConfiguration-basic" : { "summary" : "Update notification configurations", "value" : { @@ -1232,29 +1233,6 @@ "sslProtocol" : "TLSv10" } } - }, - "post-updateNotificationConfiguration-basic-200" : { - "summary" : "Example response for request 'basic'", - "value" : { - "pspReference" : "8516178952580574", - "configurationDetails" : { - "active" : false, - "description" : "Test notif config 756", - "eventConfigs" : [ - { - "eventType" : "ACCOUNT_CREATED", - "includeMode" : "INCLUDE" - }, - { - "eventType" : "ACCOUNT_HOLDER_CREATED", - "includeMode" : "EXCLUDE" - } - ], - "notificationId" : 21259, - "notifyURL" : "https://www.adyen.com/notification-handler", - "sslProtocol" : "TLSv10" - } - } } } } diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 943caeb..a82530a 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v25" @@ -24,11 +24,24 @@ "paths" : { "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -60,8 +73,8 @@ "content" : { "application/json" : { "examples" : { - "authorise-recurringcontauth-200" : { - "$ref" : "#/components/examples/post-authorise-authorise-recurringcontauth-200" + "authorise-recurringcontauth" : { + "$ref" : "#/components/examples/post-authorise-authorise-recurringcontauth" } }, "schema" : { @@ -75,8 +88,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -90,8 +103,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -125,8 +138,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -141,11 +154,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -175,8 +201,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -190,8 +216,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -225,8 +251,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -241,11 +267,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -275,8 +314,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -290,8 +329,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -325,8 +364,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -341,11 +380,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -365,8 +417,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -380,8 +432,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -395,8 +447,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -430,8 +482,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -446,11 +498,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -470,8 +535,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -485,8 +550,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -500,8 +565,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -535,8 +600,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -551,11 +616,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -575,8 +653,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -590,8 +668,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -605,8 +683,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -640,8 +718,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -656,12 +734,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -684,11 +775,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -702,8 +793,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -717,8 +808,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -752,8 +843,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1023,6 +1114,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1289,10 +1390,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1518,38 +1615,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1709,7 +1774,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1738,7 +1803,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1836,12 +1901,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -1923,12 +1988,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2014,12 +2079,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2378,7 +2443,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2387,7 +2452,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2397,7 +2462,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2411,19 +2476,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2437,7 +2502,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2446,7 +2511,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2455,12 +2520,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2472,7 +2537,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2520,12 +2585,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2538,24 +2603,24 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, @@ -2633,7 +2698,7 @@ "$ref" : "#/components/schemas/Amount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2642,13 +2707,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2662,13 +2727,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -2679,12 +2744,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2697,12 +2762,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2756,12 +2821,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2774,24 +2839,24 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, @@ -2867,7 +2932,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2918,7 +2983,7 @@ "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -3004,12 +3069,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3037,6 +3102,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -3228,6 +3297,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -3621,12 +3701,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3648,16 +3728,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -3666,16 +3737,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-authorise-authorise-3dsecure" : { "summary" : "Initiate a 3D Secure payment", "value" : { @@ -3717,25 +3778,6 @@ } }, "post-authorise-authorise-recurringcontauth" : { - "summary" : "Authorise a recurring payment", - "value" : { - "amount" : { - "value" : 2000, - "currency" : "EUR" - }, - "reference" : "YOUR_REFERENCE", - "shopperEmail" : "s.hopper@test.com", - "shopperIP" : "61.294.12.12", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "selectedRecurringDetailReference" : "LATEST", - "recurring" : { - "contract" : "RECURRING" - }, - "shopperInteraction" : "ContAuth", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-authorise-authorise-recurringcontauth-200" : { "summary" : "Example response for request 'authorise-recurringcontauth'", "value" : { "additionalData" : { @@ -3819,13 +3861,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -3838,13 +3873,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-refund-refund" : { "summary" : "Refund a captured payment", "value" : { @@ -3857,13 +3885,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-pspreference" : { "summary" : "Cancel a POS refund request with PSP reference before it has been completed", "value" : { @@ -3871,22 +3892,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index 90c5070..c640d8e 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v30" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -179,8 +205,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -194,8 +220,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -229,8 +255,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -245,11 +271,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -279,8 +318,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -294,8 +333,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -329,8 +368,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -345,11 +384,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -379,8 +431,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -394,8 +446,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -429,8 +481,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -445,11 +497,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -469,8 +534,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -484,8 +549,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -499,8 +564,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -534,8 +599,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -550,11 +615,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -574,8 +652,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -589,8 +667,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -604,8 +682,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -639,8 +717,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -655,11 +733,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -679,8 +770,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -694,8 +785,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -709,8 +800,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -744,8 +835,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -760,12 +851,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -785,8 +889,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -800,8 +904,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -815,8 +919,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -850,8 +954,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -866,12 +970,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -894,11 +1011,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -912,8 +1029,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -927,8 +1044,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -962,8 +1079,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,6 +1350,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1499,10 +1626,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1728,38 +1851,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1961,7 +2052,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -1974,12 +2065,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2016,7 +2107,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2045,7 +2136,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2135,7 +2226,7 @@ "type" : "string" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2148,12 +2239,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2227,7 +2318,7 @@ "type" : "string" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2240,12 +2331,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2323,7 +2414,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2336,12 +2427,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2700,7 +2791,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2709,7 +2800,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2719,7 +2810,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2733,19 +2824,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2759,7 +2850,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2768,7 +2859,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2777,12 +2868,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2794,7 +2885,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2808,7 +2899,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2852,12 +2943,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2870,24 +2961,24 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, @@ -2965,7 +3056,7 @@ "$ref" : "#/components/schemas/Amount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2974,13 +3065,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2994,13 +3085,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -3011,12 +3102,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3029,12 +3120,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3054,7 +3145,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3098,12 +3189,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3116,24 +3207,24 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, @@ -3209,7 +3300,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -3260,7 +3351,7 @@ "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -3338,7 +3429,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -3351,12 +3442,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3384,6 +3475,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -3575,6 +3670,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -3914,7 +4020,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -3923,12 +4029,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4052,7 +4158,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4065,12 +4171,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4092,16 +4198,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -4110,16 +4207,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -4132,13 +4219,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3dsecure" : { "summary" : "Initiate a 3D Secure payment", "value" : { @@ -4301,13 +4381,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -4320,13 +4393,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-refund-refund" : { "summary" : "Refund a captured payment", "value" : { @@ -4339,22 +4405,7 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -4368,22 +4419,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 6abab7d..967497e 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v40" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,11 +964,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -884,8 +1001,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -899,8 +1016,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -914,8 +1031,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -949,8 +1066,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -965,12 +1082,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1091,8 +1234,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1106,8 +1249,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1121,8 +1264,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1156,8 +1299,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1172,12 +1315,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1200,11 +1356,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1218,8 +1374,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,8 +1389,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1268,8 +1424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1657,6 +1813,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1923,10 +2089,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2152,38 +2314,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2385,7 +2515,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2398,7 +2528,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2406,12 +2536,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2476,7 +2606,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2505,7 +2635,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2520,41 +2650,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2641,7 +2771,7 @@ "type" : "string" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2654,12 +2784,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2733,7 +2863,7 @@ "type" : "string" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2746,7 +2876,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2754,12 +2884,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2837,7 +2967,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2850,7 +2980,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2858,12 +2988,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3317,7 +3447,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3384,7 +3514,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3393,7 +3523,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3402,7 +3532,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3412,7 +3542,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3426,19 +3556,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3452,7 +3582,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3461,7 +3591,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3470,17 +3600,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3492,7 +3622,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3506,7 +3636,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3550,12 +3680,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3568,12 +3698,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3581,31 +3711,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3619,7 +3749,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3686,12 +3816,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3700,13 +3830,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3720,13 +3850,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -3737,12 +3867,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3755,17 +3885,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3785,7 +3915,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3829,12 +3959,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3847,12 +3977,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3860,31 +3990,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3898,7 +4028,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3965,12 +4095,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3979,13 +4109,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3999,13 +4129,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4016,12 +4146,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4030,17 +4160,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4056,7 +4186,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4100,12 +4230,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4118,12 +4248,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4131,19 +4261,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4156,14 +4286,14 @@ "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4237,7 +4367,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4288,18 +4418,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4377,7 +4507,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4390,7 +4520,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4398,12 +4528,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4431,6 +4561,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4622,6 +4756,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4667,7 +4812,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4680,12 +4825,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -5072,7 +5217,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5081,7 +5226,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5089,12 +5234,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5165,7 +5310,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5282,7 +5427,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5291,7 +5436,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5370,7 +5515,7 @@ "$ref" : "#/components/schemas/Amount" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5383,7 +5528,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5391,12 +5536,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5418,16 +5563,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5436,16 +5572,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5458,13 +5584,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -5686,13 +5805,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -5705,13 +5817,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -5737,13 +5842,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -5752,14 +5850,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -5773,22 +5863,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index fa72602..e3279f5 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v46" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,11 +964,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -884,8 +1001,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -899,8 +1016,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -914,8 +1031,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -949,8 +1066,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -965,12 +1082,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1091,8 +1234,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1106,8 +1249,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1121,8 +1264,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1156,8 +1299,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1172,12 +1315,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1200,11 +1356,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1218,8 +1374,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,8 +1389,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1268,8 +1424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1657,6 +1813,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1923,10 +2089,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2152,38 +2314,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2385,12 +2515,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2403,7 +2533,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2411,12 +2541,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2481,7 +2611,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2510,7 +2640,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2525,41 +2655,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2646,12 +2776,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2664,12 +2794,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2743,12 +2873,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2761,7 +2891,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2769,12 +2899,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2852,12 +2982,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2870,7 +3000,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2878,12 +3008,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3337,7 +3467,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3404,7 +3534,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3413,7 +3543,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3422,7 +3552,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3432,7 +3562,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3446,19 +3576,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3472,7 +3602,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3481,7 +3611,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3490,17 +3620,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3512,7 +3642,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3526,7 +3656,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3570,12 +3700,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3588,12 +3718,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3601,31 +3731,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3639,7 +3769,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3706,12 +3836,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3720,13 +3850,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3740,13 +3870,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -3757,12 +3887,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3775,17 +3905,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3805,7 +3935,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3849,12 +3979,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3867,12 +3997,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3880,31 +4010,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3918,7 +4048,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3985,12 +4115,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3999,13 +4129,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4019,13 +4149,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4036,12 +4166,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4050,17 +4180,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4076,7 +4206,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4120,12 +4250,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4138,12 +4268,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4151,19 +4281,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4176,14 +4306,14 @@ "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4257,7 +4387,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4308,18 +4438,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4397,12 +4527,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4415,7 +4545,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4423,12 +4553,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4456,6 +4586,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4647,6 +4781,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4692,7 +4837,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4705,12 +4850,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -4936,7 +5081,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -5105,12 +5250,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5119,7 +5264,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5127,12 +5272,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5203,7 +5348,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5320,7 +5465,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5329,7 +5474,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5408,12 +5553,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5426,7 +5571,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5434,12 +5579,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5461,16 +5606,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5479,16 +5615,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5501,13 +5627,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -5729,13 +5848,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -5748,13 +5860,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -5780,13 +5885,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -5795,14 +5893,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -5816,22 +5906,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 9024e74..58fb9ba 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v49" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,11 +964,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -884,8 +1001,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -899,8 +1016,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -914,8 +1031,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -949,8 +1066,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -965,12 +1082,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1091,8 +1234,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1106,8 +1249,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1121,8 +1264,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1156,8 +1299,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1172,12 +1315,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1200,11 +1356,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1218,8 +1374,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,8 +1389,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1268,8 +1424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1657,6 +1813,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1923,10 +2089,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2152,38 +2314,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2385,12 +2515,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2403,7 +2533,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2411,12 +2541,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2481,7 +2611,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2510,7 +2640,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2525,41 +2655,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2646,12 +2776,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2664,12 +2794,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2743,12 +2873,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2761,7 +2891,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2769,12 +2899,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2852,12 +2982,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2870,7 +3000,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2878,12 +3008,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3337,7 +3467,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3404,7 +3534,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3413,7 +3543,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3422,7 +3552,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3432,7 +3562,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3446,19 +3576,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3472,7 +3602,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3481,7 +3611,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3490,17 +3620,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3512,7 +3642,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3526,7 +3656,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3570,12 +3700,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3588,12 +3718,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3601,31 +3731,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3639,7 +3769,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3706,12 +3836,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3720,13 +3850,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3740,13 +3870,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -3757,12 +3887,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3775,17 +3905,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3805,7 +3935,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3849,12 +3979,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3867,12 +3997,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3880,31 +4010,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3918,7 +4048,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3985,12 +4115,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3999,13 +4129,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4019,13 +4149,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4036,12 +4166,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4050,17 +4180,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4076,7 +4206,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4120,12 +4250,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4138,12 +4268,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4151,19 +4281,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4176,14 +4306,14 @@ "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4257,7 +4387,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4308,18 +4438,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4397,12 +4527,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4415,7 +4545,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4423,12 +4553,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4456,6 +4586,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4647,6 +4781,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4692,7 +4837,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4705,12 +4850,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -4936,7 +5081,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -5105,12 +5250,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5119,7 +5264,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5127,12 +5272,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5145,12 +5290,12 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, @@ -5178,12 +5323,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -5223,7 +5368,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5244,7 +5389,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -5268,7 +5413,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -5289,7 +5434,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -5355,7 +5500,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5364,7 +5509,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5443,12 +5588,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5461,7 +5606,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5469,12 +5614,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5496,16 +5641,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5514,16 +5650,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5536,13 +5662,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -5764,13 +5883,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -5783,13 +5895,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -5815,13 +5920,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -5830,14 +5928,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -5851,22 +5941,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 799086e..49f695b 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v50" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,11 +964,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -884,8 +1001,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -899,8 +1016,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -914,8 +1031,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -949,8 +1066,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -965,12 +1082,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1091,8 +1234,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1106,8 +1249,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1121,8 +1264,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1156,8 +1299,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1172,12 +1315,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1200,11 +1356,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1218,8 +1374,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1233,8 +1389,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1268,8 +1424,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1319,7 +1475,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -1667,6 +1823,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1933,10 +2099,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2162,38 +2324,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2395,12 +2525,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2413,7 +2543,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2421,12 +2551,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2491,7 +2621,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2520,7 +2650,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2535,41 +2665,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2656,12 +2786,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2674,12 +2804,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2753,12 +2883,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2771,7 +2901,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2779,12 +2909,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2862,12 +2992,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2880,7 +3010,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2888,12 +3018,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3347,7 +3477,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3414,7 +3544,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3423,7 +3553,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3432,7 +3562,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3442,7 +3572,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3456,19 +3586,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3482,7 +3612,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3491,7 +3621,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3500,17 +3630,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3522,7 +3652,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3536,7 +3666,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3580,12 +3710,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3598,12 +3728,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3611,37 +3741,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3655,7 +3785,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3722,12 +3852,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3736,13 +3866,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3756,13 +3886,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -3773,12 +3903,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3791,17 +3921,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3821,7 +3951,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3865,12 +3995,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3883,12 +4013,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3896,37 +4026,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3940,7 +4070,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4007,12 +4137,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4021,13 +4151,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4041,13 +4171,13 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" @@ -4058,12 +4188,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4072,17 +4202,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4098,7 +4228,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4142,12 +4272,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4160,12 +4290,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4173,19 +4303,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4198,20 +4328,20 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4285,7 +4415,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4336,18 +4466,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4425,12 +4555,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4443,7 +4573,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4451,12 +4581,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4484,6 +4614,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4675,6 +4809,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4720,7 +4865,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4733,12 +4878,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -4964,7 +5109,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -5133,12 +5278,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5147,7 +5292,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5155,12 +5300,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5173,18 +5318,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -5209,12 +5354,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -5254,7 +5399,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5275,7 +5420,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -5287,7 +5432,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -5303,7 +5448,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -5316,7 +5461,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -5337,7 +5482,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -5403,7 +5548,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5412,7 +5557,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5491,12 +5636,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5509,7 +5654,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5517,12 +5662,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5544,16 +5689,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5562,16 +5698,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5584,13 +5710,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -5812,13 +5931,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -5831,13 +5943,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -5863,13 +5968,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -5878,14 +5976,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -5899,22 +5989,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index 5f4008a..fb642f9 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v51" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,12 +964,25 @@ }, "/getAuthenticationResult" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Return the authentication result after doing a 3D Secure authentication only.", "description" : "Return the authentication result after doing a 3D Secure authentication only.", - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -895,8 +1012,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -910,8 +1027,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -945,8 +1062,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -961,11 +1078,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -985,8 +1115,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1101,8 +1244,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1259,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1151,8 +1294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1167,12 +1310,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1192,8 +1348,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1207,8 +1363,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1222,8 +1378,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1257,8 +1413,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1273,12 +1429,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1301,11 +1470,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1319,8 +1488,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1334,8 +1503,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1369,8 +1538,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1420,7 +1589,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -1768,6 +1937,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2034,10 +2213,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2263,38 +2438,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2496,12 +2639,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2514,7 +2657,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2522,12 +2665,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2620,7 +2763,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2649,7 +2792,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2664,41 +2807,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2785,12 +2928,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2803,12 +2946,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2882,12 +3025,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2900,7 +3043,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2908,12 +3051,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2991,12 +3134,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -3009,7 +3152,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3017,12 +3160,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3476,7 +3619,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3543,7 +3686,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3552,7 +3695,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3561,7 +3704,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3571,7 +3714,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3585,25 +3728,25 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3617,7 +3760,7 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3626,7 +3769,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3635,17 +3778,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3657,7 +3800,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3671,7 +3814,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3715,12 +3858,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3733,12 +3876,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3746,37 +3889,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3790,7 +3933,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3857,12 +4000,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3871,13 +4014,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3891,19 +4034,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -3914,12 +4057,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3932,17 +4075,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3962,7 +4105,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4006,12 +4149,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4024,12 +4167,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4037,37 +4180,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4081,7 +4224,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4148,12 +4291,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4162,13 +4305,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4182,19 +4325,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4205,12 +4348,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4219,17 +4362,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4245,7 +4388,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4289,12 +4432,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4307,12 +4450,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4320,19 +4463,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4345,20 +4488,20 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4432,7 +4575,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4483,18 +4626,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4572,12 +4715,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4590,7 +4733,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4598,12 +4741,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4631,6 +4774,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4822,6 +4969,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4867,7 +5025,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4880,12 +5038,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -5111,7 +5269,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -5280,12 +5438,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5294,7 +5452,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5302,12 +5460,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5348,18 +5506,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -5384,12 +5542,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -5429,7 +5587,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5450,7 +5608,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -5462,7 +5620,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -5478,7 +5636,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -5491,7 +5649,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -5512,7 +5670,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -5578,7 +5736,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5587,7 +5745,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5666,12 +5824,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5684,7 +5842,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5692,12 +5850,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5719,16 +5877,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5737,16 +5886,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5759,13 +5898,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -5987,13 +6119,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -6006,13 +6131,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -6045,13 +6163,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -6060,14 +6171,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -6081,22 +6184,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index bafb423..e99eca8 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v52" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,12 +964,25 @@ }, "/getAuthenticationResult" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Return the authentication result after doing a 3D Secure authentication only.", "description" : "Return the authentication result after doing a 3D Secure authentication only.", - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -895,8 +1012,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -910,8 +1027,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -945,8 +1062,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -961,11 +1078,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -985,8 +1115,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1101,8 +1244,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1259,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1151,8 +1294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1167,12 +1310,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1192,8 +1348,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1207,8 +1363,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1222,8 +1378,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1257,8 +1413,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1273,12 +1429,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1301,11 +1470,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1319,8 +1488,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1334,8 +1503,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1369,8 +1538,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1420,7 +1589,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -1768,6 +1937,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2034,10 +2213,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2263,38 +2438,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2496,12 +2639,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2514,7 +2657,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2522,12 +2665,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2620,7 +2763,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2649,7 +2792,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2664,41 +2807,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2785,12 +2928,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2803,12 +2946,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2882,12 +3025,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2900,7 +3043,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2908,12 +3051,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2991,12 +3134,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -3009,7 +3152,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3017,12 +3160,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3476,7 +3619,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3543,7 +3686,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3552,7 +3695,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3561,7 +3704,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3571,7 +3714,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3585,25 +3728,25 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3617,7 +3760,7 @@ "type" : "integer" }, "fundingSource" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", "enum" : [ "debit" @@ -3625,7 +3768,7 @@ "type" : "string" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3634,7 +3777,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3643,17 +3786,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3665,7 +3808,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3679,7 +3822,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3723,12 +3866,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3741,12 +3884,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3754,37 +3897,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3798,7 +3941,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3865,12 +4008,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3879,13 +4022,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3899,19 +4042,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -3922,12 +4065,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3940,17 +4083,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3970,7 +4113,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4014,12 +4157,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4032,12 +4175,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4045,37 +4188,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4089,7 +4232,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4156,12 +4299,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4170,13 +4313,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4190,19 +4333,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4213,12 +4356,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4227,17 +4370,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4253,7 +4396,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4297,12 +4440,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4315,12 +4458,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4328,19 +4471,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4353,20 +4496,20 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4440,7 +4583,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4491,18 +4634,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4580,12 +4723,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4598,7 +4741,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4606,12 +4749,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4639,6 +4782,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4830,6 +4977,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4875,7 +5033,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4888,12 +5046,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -5119,7 +5277,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -5288,12 +5446,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5302,7 +5460,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5310,12 +5468,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5356,18 +5514,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -5392,12 +5550,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -5437,7 +5595,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5458,7 +5616,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -5470,7 +5628,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -5486,7 +5644,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -5499,7 +5657,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -5520,7 +5678,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -5586,7 +5744,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5595,7 +5753,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5674,12 +5832,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5692,7 +5850,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5700,12 +5858,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5727,16 +5885,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5745,16 +5894,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5767,13 +5906,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -5995,13 +6127,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -6014,13 +6139,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -6053,13 +6171,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -6068,14 +6179,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -6089,22 +6192,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index b1c8993..6a0f5f2 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payment/v64" @@ -24,12 +24,25 @@ "paths" : { "/adjustAuthorisation" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Increases or decreases the authorised amount.", "description" : "Allows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\n> If you have a [newer integration](https://docs.adyen.com/online-payments), and are doing:\n> * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) endpoint on Checkout API.\n> * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), use this endpoint.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-adjustAuthorisation", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -49,8 +62,8 @@ "content" : { "application/json" : { "examples" : { - "adjustAuthorisation-200" : { - "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200" + "adjustAuthorisation" : { + "$ref" : "#/components/examples/post-adjustAuthorisation-adjustAuthorisation" } }, "schema" : { @@ -64,8 +77,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -79,8 +92,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -114,8 +127,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -130,11 +143,24 @@ }, "/authorise" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates a payment authorisation.", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -182,8 +208,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -197,8 +223,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -232,8 +258,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -248,11 +274,24 @@ }, "/authorise3d" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure payment authorisation.", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -282,8 +321,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -297,8 +336,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -332,8 +371,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -348,12 +387,25 @@ }, "/authorise3ds2" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Completes a 3D Secure 2 payment authorisation.", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -383,8 +435,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -398,8 +450,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -433,8 +485,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -449,11 +501,24 @@ }, "/cancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels an authorised payment.", "description" : "Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.\n\nFor more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) endpoint under Checkout API instead.", "operationId" : "post-cancel", "x-groupName" : "Modifications", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -483,8 +548,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -498,8 +563,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -533,8 +598,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -549,11 +614,24 @@ }, "/cancelOrRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels or refunds a payment.", "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -573,8 +651,8 @@ "content" : { "application/json" : { "examples" : { - "cancelOrRefund-200" : { - "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund-200" + "cancelOrRefund" : { + "$ref" : "#/components/examples/post-cancelOrRefund-cancelOrRefund" } }, "schema" : { @@ -588,8 +666,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -603,8 +681,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -638,8 +716,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -654,11 +732,24 @@ }, "/capture" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Captures an authorised payment.", "description" : "Captures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance.\n\nPayment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabled, calling the capture method is not neccessary.\n\nFor more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) endpoint on Checkout API instead.\n\n", "operationId" : "post-capture", "x-groupName" : "Modifications", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -678,8 +769,8 @@ "content" : { "application/json" : { "examples" : { - "capture-200" : { - "$ref" : "#/components/examples/post-capture-capture-200" + "capture" : { + "$ref" : "#/components/examples/post-capture-capture" } }, "schema" : { @@ -693,8 +784,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -708,8 +799,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -743,8 +834,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -759,12 +850,25 @@ }, "/donate" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Creates a payment for the specified donation.", - "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\nFor more information, see [Donate](https://docs.adyen.com/online-payments/donate).", - "x-addedInVersion" : 40, + "description" : "Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) endpoint under Checkout API instead.", + "x-addedInVersion" : "40", "operationId" : "post-donate", "x-groupName" : "Modifications", "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -794,8 +898,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -809,8 +913,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -844,8 +948,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -860,12 +964,25 @@ }, "/getAuthenticationResult" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Return the authentication result after doing a 3D Secure authentication only.", "description" : "Return the authentication result after doing a 3D Secure authentication only.", - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -895,8 +1012,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -910,8 +1027,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -945,8 +1062,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -961,11 +1078,24 @@ }, "/refund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Refunds a captured payment.", "description" : "Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.\n\nSome payment methods/gateways do not support partial/multiple refunds.\nA margin above the captured limit can be configured to cover shipping/handling costs.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) endpoint under Checkout API instead.", "operationId" : "post-refund", "x-groupName" : "Modifications", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -985,8 +1115,8 @@ "content" : { "application/json" : { "examples" : { - "refund-200" : { - "$ref" : "#/components/examples/post-refund-refund-200" + "refund" : { + "$ref" : "#/components/examples/post-refund-refund" } }, "schema" : { @@ -1000,8 +1130,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1015,8 +1145,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1050,8 +1180,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1066,12 +1196,25 @@ }, "/retrieve3ds2Result" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", "x-groupName" : "General", "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1101,8 +1244,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1116,8 +1259,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1151,8 +1294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1167,12 +1310,25 @@ }, "/technicalCancel" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a payment using your custom reference.", "description" : "This endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available.\n\nIn your call, refer to the original payment by using the `reference` that you specified in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel). \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels) endpoint under Checkout API instead.", - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "operationId" : "post-technicalCancel", "x-groupName" : "Modifications", "x-sortIndex" : 5, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1192,8 +1348,8 @@ "content" : { "application/json" : { "examples" : { - "technicalCancel-200" : { - "$ref" : "#/components/examples/post-technicalCancel-technicalCancel-200" + "technicalCancel" : { + "$ref" : "#/components/examples/post-technicalCancel-technicalCancel" } }, "schema" : { @@ -1207,8 +1363,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1222,8 +1378,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1257,8 +1413,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1273,12 +1429,25 @@ }, "/voidPendingRefund" : { "post" : { + "tags" : [ + "Modifications" + ], "summary" : "Cancels a POS refund request before it has been completed.", "description" : "This endpoint allows you to cancel the refund request before it has been completed.\n\nIn your call, you can refer to the original refund request either by using the `tenderReference`, or the `pspReference`. We recommend implementing based on the `tenderReference`, as this is generated for both offline and online transactions.\n\nFor more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "operationId" : "post-voidPendingRefund", "x-groupName" : "Modifications", "x-sortIndex" : 7, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -1301,11 +1470,11 @@ "content" : { "application/json" : { "examples" : { - "voidpendingrefund-pspreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200" + "voidpendingrefund-pspreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference" }, - "voidpendingrefund-tenderreference-200" : { - "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200" + "voidpendingrefund-tenderreference" : { + "$ref" : "#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference" } }, "schema" : { @@ -1319,8 +1488,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1334,8 +1503,8 @@ "content" : { "application/json" : { "examples" : { - "generic-401" : { - "$ref" : "#/components/examples/generic-401" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1369,8 +1538,8 @@ "content" : { "application/json" : { "examples" : { - "generic-500" : { - "$ref" : "#/components/examples/generic-500" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -1420,7 +1589,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -1768,6 +1937,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2034,10 +2213,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -2263,38 +2438,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -2496,12 +2639,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2514,7 +2657,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2522,12 +2665,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2620,7 +2763,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -2649,7 +2792,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -2664,41 +2807,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2785,12 +2928,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2803,12 +2946,12 @@ "type" : "string" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2882,12 +3025,12 @@ "type" : "string" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -2900,7 +3043,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2908,12 +3051,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -2991,12 +3134,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -3009,7 +3152,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3017,12 +3160,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -3282,7 +3425,7 @@ "Installments" : { "properties" : { "plan" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "enum" : [ "regular", @@ -3485,7 +3628,7 @@ "PaymentRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3552,7 +3695,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -3561,7 +3704,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3570,7 +3713,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -3580,7 +3723,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3594,25 +3737,25 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -3626,7 +3769,7 @@ "type" : "integer" }, "fundingSource" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", "enum" : [ "debit" @@ -3634,7 +3777,7 @@ "type" : "string" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -3643,7 +3786,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3652,17 +3795,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3674,7 +3817,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -3688,7 +3831,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -3732,12 +3875,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -3750,12 +3893,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -3763,37 +3906,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -3807,7 +3950,7 @@ "PaymentRequest3d" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -3874,12 +4017,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -3888,13 +4031,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -3908,19 +4051,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -3931,12 +4074,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -3949,17 +4092,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -3979,7 +4122,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4023,12 +4166,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4041,12 +4184,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4054,37 +4197,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4098,7 +4241,7 @@ "PaymentRequest3ds2" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -4165,12 +4308,12 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -4179,13 +4322,13 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -4199,19 +4342,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" @@ -4222,12 +4365,12 @@ "type" : "integer" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -4236,17 +4379,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -4262,7 +4405,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -4306,12 +4449,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -4324,12 +4467,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4337,19 +4480,19 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, @@ -4362,20 +4505,20 @@ "type" : "string" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -4449,7 +4592,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -4500,18 +4643,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -4589,12 +4732,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -4607,7 +4750,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -4615,12 +4758,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -4648,6 +4791,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -4839,6 +4986,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -4884,7 +5042,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -4897,12 +5055,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -5128,7 +5286,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -5297,12 +5455,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5311,7 +5469,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5319,12 +5477,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5365,18 +5523,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -5401,12 +5559,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -5446,7 +5604,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -5467,7 +5625,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -5479,7 +5637,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -5495,7 +5653,7 @@ "type" : "string" }, "cavvAlgorithm" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.", "type" : "string" }, @@ -5508,7 +5666,7 @@ "type" : "string" }, "messageVersion" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type" : "string" }, @@ -5529,7 +5687,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type" : "string" } @@ -5595,7 +5753,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -5604,7 +5762,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -5683,12 +5841,12 @@ "$ref" : "#/components/schemas/Amount" }, "mpiData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).", "$ref" : "#/components/schemas/ThreeDSecureData" }, "originalMerchantReference" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "The original merchant reference to cancel.", "type" : "string" }, @@ -5701,7 +5859,7 @@ "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" @@ -5709,12 +5867,12 @@ "type" : "array" }, "tenderReference" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", "type" : "string" }, "uniqueTerminalId" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.", "type" : "string" } @@ -5736,16 +5894,7 @@ } }, "examples" : { - "generic-400" : { - "summary" : "Response code 400. Bad request.", - "value" : { - "status" : 400, - "errorCode" : "702", - "message" : "Unexpected input: \", expected: }", - "errorType" : "validation" - } - }, - "generic-401" : { + "generic" : { "summary" : "Response code 401. Unauthorized.", "value" : { "status" : 401, @@ -5754,16 +5903,6 @@ "errorType" : "security" } }, - "generic-500" : { - "summary" : "Response code 500. Internal server error.", - "value" : { - "status" : 500, - "errorCode" : "905", - "message" : "Payment details are not supported", - "errorType" : "configuration", - "pspReference" : "8516091485743033" - } - }, "post-adjustAuthorisation-adjustAuthorisation" : { "summary" : "Increases or decreases the authorised amount", "value" : { @@ -5776,13 +5915,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-adjustAuthorisation-adjustAuthorisation-200" : { - "summary" : "Example response for request 'adjustAuthorisation'", - "value" : { - "pspReference" : "851617892360718D", - "response" : "[adjustAuthorisation-received]" - } - }, "post-authorise-authorise-3d-secure-2" : { "summary" : "Make a card payment with 3D Secure 2 native authentication", "value" : { @@ -6004,13 +6136,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-cancelOrRefund-cancelOrRefund-200" : { - "summary" : "Example response for request 'cancelOrRefund'", - "value" : { - "pspReference" : "851617892359708H", - "response" : "[cancelOrRefund-received]" - } - }, "post-capture-capture" : { "summary" : "Capture an authorised payment", "value" : { @@ -6023,13 +6148,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-capture-capture-200" : { - "summary" : "Example response for request 'capture'", - "value" : { - "pspReference" : "861617892359057J", - "response" : "[capture-received]" - } - }, "post-donate-donate" : { "summary" : "Create a payment for the specified donation", "value" : { @@ -6062,13 +6180,6 @@ "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" } }, - "post-refund-refund-200" : { - "summary" : "Example response for request 'refund'", - "value" : { - "pspReference" : "861617892360059B", - "response" : "[refund-received]" - } - }, "post-retrieve3ds2Result-retrieve3ds2Result" : { "summary" : "Retrieve authentication details after doing a 3D Secure 2 authentication only", "value" : { @@ -6077,14 +6188,6 @@ } }, "post-technicalCancel-technicalCancel" : { - "summary" : "Cancel a payment without a PSP reference", - "value" : { - "originalMerchantReference" : "YOUR_MERCHANT_REFERENCE", - "reference" : "YOUR_MODIFICATION_REFERENCE", - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT" - } - }, - "post-technicalCancel-technicalCancel-200" : { "summary" : "Example response for request 'technicalCancel'", "value" : { "pspReference" : "881617892361436J", @@ -6098,22 +6201,7 @@ "originalReference" : "9914748988390044" } }, - "post-voidPendingRefund-voidpendingrefund-pspreference-200" : { - "summary" : "Example response for request 'voidpendingrefund-pspreference'", - "value" : { - "pspReference" : "861617892360062F", - "response" : "[voidPendingRefund-received]" - } - }, "post-voidPendingRefund-voidpendingrefund-tenderreference" : { - "summary" : "Cancels a POS refund request with tender reference before it has been completed", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "tenderReference" : "5Iw8001176969533005", - "uniqueTerminalId" : "VX820-123456789" - } - }, - "post-voidPendingRefund-voidpendingrefund-tenderreference-200" : { "summary" : "Example response for request 'voidpendingrefund-tenderreference'", "value" : { "pspReference" : "881617892360409G", diff --git a/json/PayoutService-v30.json b/json/PayoutService-v30.json index e2255a7..afd32bd 100644 --- a/json/PayoutService-v30.json +++ b/json/PayoutService-v30.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payout/v30" @@ -25,12 +25,25 @@ "paths" : { "/confirmThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Confirms a payout.", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -50,8 +63,8 @@ "content" : { "application/json" : { "examples" : { - "confirmThirdParty-200" : { - "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty-200" + "confirmThirdParty" : { + "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty" } }, "schema" : { @@ -65,8 +78,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -121,12 +134,25 @@ }, "/declineThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Cancels a payout.", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -146,8 +172,8 @@ "content" : { "application/json" : { "examples" : { - "declineThirdParty-200" : { - "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty-200" + "declineThirdParty" : { + "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty" } }, "schema" : { @@ -161,8 +187,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -217,12 +243,25 @@ }, "/payout" : { "post" : { + "tags" : [ + "Instant payouts" + ], "summary" : "Pay out directly.", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", - "x-addedInVersion" : 11, + "x-addedInVersion" : "11", "operationId" : "post-payout", "x-groupName" : "Instant payouts", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -255,8 +294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -311,11 +350,24 @@ }, "/storeDetail" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores payout details.", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -335,8 +387,8 @@ "content" : { "application/json" : { "examples" : { - "storeDetail-200" : { - "$ref" : "#/components/examples/post-storeDetail-storeDetail-200" + "storeDetail" : { + "$ref" : "#/components/examples/post-storeDetail-storeDetail" } }, "schema" : { @@ -350,8 +402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -406,12 +458,25 @@ }, "/storeDetailAndSubmitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores details and submits a payout.", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -453,8 +518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -509,12 +574,25 @@ }, "/submitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Submits a payout.", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -544,8 +622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -855,6 +933,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1113,10 +1201,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1342,38 +1426,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1533,7 +1585,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1562,7 +1614,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1980,7 +2032,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -1989,7 +2041,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -1999,7 +2051,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2013,19 +2065,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2043,7 +2095,7 @@ "$ref" : "#/components/schemas/FundSource" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2052,7 +2104,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2061,12 +2113,12 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2078,7 +2130,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2092,7 +2144,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2136,12 +2188,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2154,24 +2206,24 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, @@ -2247,7 +2299,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2298,7 +2350,7 @@ "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -2325,6 +2377,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -2516,6 +2572,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -2805,7 +2872,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -2814,13 +2881,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -2838,7 +2905,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -2852,7 +2919,7 @@ "type" : "string" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -2861,7 +2928,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -2870,12 +2937,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -2933,7 +3000,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -2942,13 +3009,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -2966,7 +3033,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -2976,7 +3043,7 @@ "$ref" : "#/components/schemas/Recurring" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -2985,7 +3052,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -2994,7 +3061,7 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3051,13 +3118,13 @@ "$ref" : "#/components/schemas/Amount" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.", "enum" : [ "NaturalPerson", @@ -3075,7 +3142,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.", "type" : "string" }, @@ -3096,7 +3163,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.", "$ref" : "#/components/schemas/Name" }, @@ -3105,12 +3172,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3211,7 +3278,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -3228,13 +3295,6 @@ "originalReference" : "9913140798220028" } }, - "post-confirmThirdParty-confirmThirdParty-200" : { - "summary" : "Example response for request 'confirmThirdParty'", - "value" : { - "pspReference" : "991617894325358C", - "response" : "[payout-confirm-received]" - } - }, "post-declineThirdParty-declineThirdParty" : { "summary" : "Cancel a payout", "description" : "Cancel a previously submitted payout", @@ -3243,13 +3303,6 @@ "originalReference" : "9913140798220028" } }, - "post-declineThirdParty-declineThirdParty-200" : { - "summary" : "Example response for request 'declineThirdParty'", - "value" : { - "pspReference" : "991617894325360J", - "response" : "[payout-decline-received]" - } - }, "post-payout-payout-b2c" : { "summary" : "Instant card payout (B2C)", "description" : "Pay out to your sellers, customers, freelancers, etc", @@ -3328,43 +3381,6 @@ } }, "post-storeDetail-storeDetail" : { - "summary" : "Store payout details", - "description" : "Store payment details under the PAYOUT recurring contract", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "recurring" : { - "contract" : "PAYOUT" - }, - "bank" : { - "bankName" : "AbnAmro", - "bic" : "ABNANL2A", - "countryCode" : "NL", - "iban" : "NL32ABNA0515071439", - "ownerName" : "Adyen", - "bankCity" : "Amsterdam", - "taxId" : "bankTaxId" - }, - "shopperEmail" : "shopper@email.com", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "shopperName" : { - "firstName" : "Adyen", - "gender" : "MALE", - "lastName" : "Test" - }, - "dateOfBirth" : "1990-01-01", - "entityType" : "Company", - "nationality" : "NL", - "billingAddress" : { - "houseNumberOrName" : "17", - "street" : "Teststreet 1", - "city" : "Amsterdam", - "stateOrProvince" : "NY", - "country" : "US", - "postalCode" : "12345" - } - } - }, - "post-storeDetail-storeDetail-200" : { "summary" : "Example response for request 'storeDetail'", "value" : { "pspReference" : "991617894326362D", diff --git a/json/PayoutService-v40.json b/json/PayoutService-v40.json index d00b0df..e7102a7 100644 --- a/json/PayoutService-v40.json +++ b/json/PayoutService-v40.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payout/v40" @@ -25,12 +25,25 @@ "paths" : { "/confirmThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Confirms a payout.", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -50,8 +63,8 @@ "content" : { "application/json" : { "examples" : { - "confirmThirdParty-200" : { - "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty-200" + "confirmThirdParty" : { + "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty" } }, "schema" : { @@ -65,8 +78,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -121,12 +134,25 @@ }, "/declineThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Cancels a payout.", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -146,8 +172,8 @@ "content" : { "application/json" : { "examples" : { - "declineThirdParty-200" : { - "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty-200" + "declineThirdParty" : { + "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty" } }, "schema" : { @@ -161,8 +187,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -217,12 +243,25 @@ }, "/payout" : { "post" : { + "tags" : [ + "Instant payouts" + ], "summary" : "Pay out directly.", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", - "x-addedInVersion" : 11, + "x-addedInVersion" : "11", "operationId" : "post-payout", "x-groupName" : "Instant payouts", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -255,8 +294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -311,11 +350,24 @@ }, "/storeDetail" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores payout details.", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -335,8 +387,8 @@ "content" : { "application/json" : { "examples" : { - "storeDetail-200" : { - "$ref" : "#/components/examples/post-storeDetail-storeDetail-200" + "storeDetail" : { + "$ref" : "#/components/examples/post-storeDetail-storeDetail" } }, "schema" : { @@ -350,8 +402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -406,12 +458,25 @@ }, "/storeDetailAndSubmitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores details and submits a payout.", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -453,8 +518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -509,12 +574,25 @@ }, "/submitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Submits a payout.", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -544,8 +622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -973,6 +1051,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1231,10 +1319,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1460,38 +1544,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1679,7 +1731,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1708,7 +1760,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1723,41 +1775,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2238,7 +2290,7 @@ "PayoutRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -2305,7 +2357,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -2314,7 +2366,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2323,7 +2375,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2333,7 +2385,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2347,19 +2399,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2377,7 +2429,7 @@ "$ref" : "#/components/schemas/FundSource" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2386,7 +2438,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2395,17 +2447,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2417,7 +2469,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2431,7 +2483,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2475,12 +2527,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2493,12 +2545,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2506,31 +2558,31 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -2604,7 +2656,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2655,18 +2707,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -2693,6 +2745,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -2884,6 +2940,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -2929,7 +2996,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -2942,12 +3009,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -3284,7 +3351,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3293,13 +3360,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3317,7 +3384,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3331,7 +3398,7 @@ "type" : "string" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3340,7 +3407,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3349,12 +3416,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3412,7 +3479,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3421,13 +3488,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3445,7 +3512,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3455,7 +3522,7 @@ "$ref" : "#/components/schemas/Recurring" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3464,7 +3531,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3473,7 +3540,7 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3530,13 +3597,13 @@ "$ref" : "#/components/schemas/Amount" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.", "enum" : [ "NaturalPerson", @@ -3554,7 +3621,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.", "type" : "string" }, @@ -3575,7 +3642,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.", "$ref" : "#/components/schemas/Name" }, @@ -3584,12 +3651,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3692,7 +3759,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -3753,7 +3820,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -3762,7 +3829,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -3786,7 +3853,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -3803,13 +3870,6 @@ "originalReference" : "9913140798220028" } }, - "post-confirmThirdParty-confirmThirdParty-200" : { - "summary" : "Example response for request 'confirmThirdParty'", - "value" : { - "pspReference" : "991617894325358C", - "response" : "[payout-confirm-received]" - } - }, "post-declineThirdParty-declineThirdParty" : { "summary" : "Cancel a payout", "description" : "Cancel a previously submitted payout", @@ -3818,13 +3878,6 @@ "originalReference" : "9913140798220028" } }, - "post-declineThirdParty-declineThirdParty-200" : { - "summary" : "Example response for request 'declineThirdParty'", - "value" : { - "pspReference" : "991617894325360J", - "response" : "[payout-decline-received]" - } - }, "post-payout-payout-b2c" : { "summary" : "Instant card payout (B2C)", "description" : "Pay out to your sellers, customers, freelancers, etc", @@ -3903,43 +3956,6 @@ } }, "post-storeDetail-storeDetail" : { - "summary" : "Store payout details", - "description" : "Store payment details under the PAYOUT recurring contract", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "recurring" : { - "contract" : "PAYOUT" - }, - "bank" : { - "bankName" : "AbnAmro", - "bic" : "ABNANL2A", - "countryCode" : "NL", - "iban" : "NL32ABNA0515071439", - "ownerName" : "Adyen", - "bankCity" : "Amsterdam", - "taxId" : "bankTaxId" - }, - "shopperEmail" : "shopper@email.com", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "shopperName" : { - "firstName" : "Adyen", - "gender" : "MALE", - "lastName" : "Test" - }, - "dateOfBirth" : "1990-01-01", - "entityType" : "Company", - "nationality" : "NL", - "billingAddress" : { - "houseNumberOrName" : "17", - "street" : "Teststreet 1", - "city" : "Amsterdam", - "stateOrProvince" : "NY", - "country" : "US", - "postalCode" : "12345" - } - } - }, - "post-storeDetail-storeDetail-200" : { "summary" : "Example response for request 'storeDetail'", "value" : { "pspReference" : "991617894326362D", diff --git a/json/PayoutService-v50.json b/json/PayoutService-v50.json index 0ff7443..ca80ffe 100644 --- a/json/PayoutService-v50.json +++ b/json/PayoutService-v50.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payout/v50" @@ -25,12 +25,25 @@ "paths" : { "/confirmThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Confirms a payout.", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -50,8 +63,8 @@ "content" : { "application/json" : { "examples" : { - "confirmThirdParty-200" : { - "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty-200" + "confirmThirdParty" : { + "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty" } }, "schema" : { @@ -65,8 +78,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -121,12 +134,25 @@ }, "/declineThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Cancels a payout.", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -146,8 +172,8 @@ "content" : { "application/json" : { "examples" : { - "declineThirdParty-200" : { - "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty-200" + "declineThirdParty" : { + "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty" } }, "schema" : { @@ -161,8 +187,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -217,12 +243,25 @@ }, "/payout" : { "post" : { + "tags" : [ + "Instant payouts" + ], "summary" : "Pay out directly.", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", - "x-addedInVersion" : 11, + "x-addedInVersion" : "11", "operationId" : "post-payout", "x-groupName" : "Instant payouts", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -255,8 +294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -311,11 +350,24 @@ }, "/storeDetail" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores payout details.", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -335,8 +387,8 @@ "content" : { "application/json" : { "examples" : { - "storeDetail-200" : { - "$ref" : "#/components/examples/post-storeDetail-storeDetail-200" + "storeDetail" : { + "$ref" : "#/components/examples/post-storeDetail-storeDetail" } }, "schema" : { @@ -350,8 +402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -406,12 +458,25 @@ }, "/storeDetailAndSubmitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores details and submits a payout.", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -453,8 +518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -509,12 +574,25 @@ }, "/submitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Submits a payout.", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -544,8 +622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -635,7 +713,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -983,6 +1061,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1241,10 +1329,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1470,38 +1554,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1689,7 +1741,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1718,7 +1770,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1733,41 +1785,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2248,7 +2300,7 @@ "PayoutRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -2315,7 +2367,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -2324,7 +2376,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2333,7 +2385,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2343,7 +2395,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2357,19 +2409,19 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2387,7 +2439,7 @@ "$ref" : "#/components/schemas/FundSource" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2396,7 +2448,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2405,17 +2457,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2427,7 +2479,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2441,7 +2493,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2485,12 +2537,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2503,12 +2555,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2516,37 +2568,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -2620,7 +2672,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2671,18 +2723,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -2709,6 +2761,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -2900,6 +2956,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -2945,7 +3012,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -2958,12 +3025,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -3189,7 +3256,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -3308,7 +3375,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3317,13 +3384,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3341,7 +3408,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3355,7 +3422,7 @@ "type" : "string" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3364,7 +3431,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3373,12 +3440,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3436,7 +3503,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3445,13 +3512,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3469,7 +3536,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3479,7 +3546,7 @@ "$ref" : "#/components/schemas/Recurring" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3488,7 +3555,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3497,7 +3564,7 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3554,13 +3621,13 @@ "$ref" : "#/components/schemas/Amount" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.", "enum" : [ "NaturalPerson", @@ -3578,7 +3645,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.", "type" : "string" }, @@ -3599,7 +3666,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.", "$ref" : "#/components/schemas/Name" }, @@ -3608,12 +3675,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3658,18 +3725,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -3694,12 +3761,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -3739,7 +3806,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -3760,7 +3827,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -3772,7 +3839,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -3817,7 +3884,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -3826,7 +3893,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -3850,7 +3917,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -3867,13 +3934,6 @@ "originalReference" : "9913140798220028" } }, - "post-confirmThirdParty-confirmThirdParty-200" : { - "summary" : "Example response for request 'confirmThirdParty'", - "value" : { - "pspReference" : "991617894325358C", - "response" : "[payout-confirm-received]" - } - }, "post-declineThirdParty-declineThirdParty" : { "summary" : "Cancel a payout", "description" : "Cancel a previously submitted payout", @@ -3882,13 +3942,6 @@ "originalReference" : "9913140798220028" } }, - "post-declineThirdParty-declineThirdParty-200" : { - "summary" : "Example response for request 'declineThirdParty'", - "value" : { - "pspReference" : "991617894325360J", - "response" : "[payout-decline-received]" - } - }, "post-payout-payout-b2c" : { "summary" : "Instant card payout (B2C)", "description" : "Pay out to your sellers, customers, freelancers, etc", @@ -3967,43 +4020,6 @@ } }, "post-storeDetail-storeDetail" : { - "summary" : "Store payout details", - "description" : "Store payment details under the PAYOUT recurring contract", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "recurring" : { - "contract" : "PAYOUT" - }, - "bank" : { - "bankName" : "AbnAmro", - "bic" : "ABNANL2A", - "countryCode" : "NL", - "iban" : "NL32ABNA0515071439", - "ownerName" : "Adyen", - "bankCity" : "Amsterdam", - "taxId" : "bankTaxId" - }, - "shopperEmail" : "shopper@email.com", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "shopperName" : { - "firstName" : "Adyen", - "gender" : "MALE", - "lastName" : "Test" - }, - "dateOfBirth" : "1990-01-01", - "entityType" : "Company", - "nationality" : "NL", - "billingAddress" : { - "houseNumberOrName" : "17", - "street" : "Teststreet 1", - "city" : "Amsterdam", - "stateOrProvince" : "NY", - "country" : "US", - "postalCode" : "12345" - } - } - }, - "post-storeDetail-storeDetail-200" : { "summary" : "Example response for request 'storeDetail'", "value" : { "pspReference" : "991617894326362D", diff --git a/json/PayoutService-v51.json b/json/PayoutService-v51.json index 79bda64..5ac395f 100644 --- a/json/PayoutService-v51.json +++ b/json/PayoutService-v51.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payout/v51" @@ -25,12 +25,25 @@ "paths" : { "/confirmThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Confirms a payout.", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -50,8 +63,8 @@ "content" : { "application/json" : { "examples" : { - "confirmThirdParty-200" : { - "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty-200" + "confirmThirdParty" : { + "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty" } }, "schema" : { @@ -65,8 +78,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -121,12 +134,25 @@ }, "/declineThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Cancels a payout.", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -146,8 +172,8 @@ "content" : { "application/json" : { "examples" : { - "declineThirdParty-200" : { - "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty-200" + "declineThirdParty" : { + "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty" } }, "schema" : { @@ -161,8 +187,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -217,12 +243,25 @@ }, "/payout" : { "post" : { + "tags" : [ + "Instant payouts" + ], "summary" : "Pay out directly.", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", - "x-addedInVersion" : 11, + "x-addedInVersion" : "11", "operationId" : "post-payout", "x-groupName" : "Instant payouts", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -255,8 +294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -311,11 +350,24 @@ }, "/storeDetail" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores payout details.", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -335,8 +387,8 @@ "content" : { "application/json" : { "examples" : { - "storeDetail-200" : { - "$ref" : "#/components/examples/post-storeDetail-storeDetail-200" + "storeDetail" : { + "$ref" : "#/components/examples/post-storeDetail-storeDetail" } }, "schema" : { @@ -350,8 +402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -406,12 +458,25 @@ }, "/storeDetailAndSubmitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores details and submits a payout.", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -453,8 +518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -509,12 +574,25 @@ }, "/submitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Submits a payout.", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -544,8 +622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -635,7 +713,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -983,6 +1061,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1241,10 +1329,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1470,38 +1554,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1689,7 +1741,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1718,7 +1770,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1733,41 +1785,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2248,7 +2300,7 @@ "PayoutRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -2315,7 +2367,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -2324,7 +2376,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2333,7 +2385,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2343,7 +2395,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2357,25 +2409,25 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2393,7 +2445,7 @@ "$ref" : "#/components/schemas/FundSource" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2402,7 +2454,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2411,17 +2463,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2433,7 +2485,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2447,7 +2499,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2491,12 +2543,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2509,12 +2561,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2522,37 +2574,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -2626,7 +2678,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2677,18 +2729,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -2715,6 +2767,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -2906,6 +2962,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -2951,7 +3018,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -2964,12 +3031,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -3195,7 +3262,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -3314,7 +3381,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3323,13 +3390,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3347,7 +3414,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3361,7 +3428,7 @@ "type" : "string" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3370,7 +3437,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3379,12 +3446,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3442,7 +3509,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3451,13 +3518,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3475,7 +3542,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3485,7 +3552,7 @@ "$ref" : "#/components/schemas/Recurring" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3494,7 +3561,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3503,7 +3570,7 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3560,13 +3627,13 @@ "$ref" : "#/components/schemas/Amount" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.", "enum" : [ "NaturalPerson", @@ -3584,7 +3651,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.", "type" : "string" }, @@ -3605,7 +3672,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.", "$ref" : "#/components/schemas/Name" }, @@ -3614,12 +3681,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3664,18 +3731,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -3700,12 +3767,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -3745,7 +3812,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -3766,7 +3833,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -3778,7 +3845,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -3823,7 +3890,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -3832,7 +3899,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -3856,7 +3923,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -3873,13 +3940,6 @@ "originalReference" : "9913140798220028" } }, - "post-confirmThirdParty-confirmThirdParty-200" : { - "summary" : "Example response for request 'confirmThirdParty'", - "value" : { - "pspReference" : "991617894325358C", - "response" : "[payout-confirm-received]" - } - }, "post-declineThirdParty-declineThirdParty" : { "summary" : "Cancel a payout", "description" : "Cancel a previously submitted payout", @@ -3888,13 +3948,6 @@ "originalReference" : "9913140798220028" } }, - "post-declineThirdParty-declineThirdParty-200" : { - "summary" : "Example response for request 'declineThirdParty'", - "value" : { - "pspReference" : "991617894325360J", - "response" : "[payout-decline-received]" - } - }, "post-payout-payout-b2c" : { "summary" : "Instant card payout (B2C)", "description" : "Pay out to your sellers, customers, freelancers, etc", @@ -3973,43 +4026,6 @@ } }, "post-storeDetail-storeDetail" : { - "summary" : "Store payout details", - "description" : "Store payment details under the PAYOUT recurring contract", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "recurring" : { - "contract" : "PAYOUT" - }, - "bank" : { - "bankName" : "AbnAmro", - "bic" : "ABNANL2A", - "countryCode" : "NL", - "iban" : "NL32ABNA0515071439", - "ownerName" : "Adyen", - "bankCity" : "Amsterdam", - "taxId" : "bankTaxId" - }, - "shopperEmail" : "shopper@email.com", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "shopperName" : { - "firstName" : "Adyen", - "gender" : "MALE", - "lastName" : "Test" - }, - "dateOfBirth" : "1990-01-01", - "entityType" : "Company", - "nationality" : "NL", - "billingAddress" : { - "houseNumberOrName" : "17", - "street" : "Teststreet 1", - "city" : "Amsterdam", - "stateOrProvince" : "NY", - "country" : "US", - "postalCode" : "12345" - } - } - }, - "post-storeDetail-storeDetail-200" : { "summary" : "Example response for request 'storeDetail'", "value" : { "pspReference" : "991617894326362D", diff --git a/json/PayoutService-v52.json b/json/PayoutService-v52.json index 416eb74..1b50736 100644 --- a/json/PayoutService-v52.json +++ b/json/PayoutService-v52.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payout/v52" @@ -25,12 +25,25 @@ "paths" : { "/confirmThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Confirms a payout.", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -50,8 +63,8 @@ "content" : { "application/json" : { "examples" : { - "confirmThirdParty-200" : { - "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty-200" + "confirmThirdParty" : { + "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty" } }, "schema" : { @@ -65,8 +78,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -121,12 +134,25 @@ }, "/declineThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Cancels a payout.", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -146,8 +172,8 @@ "content" : { "application/json" : { "examples" : { - "declineThirdParty-200" : { - "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty-200" + "declineThirdParty" : { + "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty" } }, "schema" : { @@ -161,8 +187,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -217,12 +243,25 @@ }, "/payout" : { "post" : { + "tags" : [ + "Instant payouts" + ], "summary" : "Pay out directly.", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", - "x-addedInVersion" : 11, + "x-addedInVersion" : "11", "operationId" : "post-payout", "x-groupName" : "Instant payouts", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -255,8 +294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -311,11 +350,24 @@ }, "/storeDetail" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores payout details.", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -335,8 +387,8 @@ "content" : { "application/json" : { "examples" : { - "storeDetail-200" : { - "$ref" : "#/components/examples/post-storeDetail-storeDetail-200" + "storeDetail" : { + "$ref" : "#/components/examples/post-storeDetail-storeDetail" } }, "schema" : { @@ -350,8 +402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -406,12 +458,25 @@ }, "/storeDetailAndSubmitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores details and submits a payout.", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -453,8 +518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -509,12 +574,25 @@ }, "/submitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Submits a payout.", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -544,8 +622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -635,7 +713,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -983,6 +1061,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1241,10 +1329,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1470,38 +1554,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1689,7 +1741,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1718,7 +1770,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1733,41 +1785,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2248,7 +2300,7 @@ "PayoutRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -2315,7 +2367,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -2324,7 +2376,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2333,7 +2385,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2343,7 +2395,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2357,25 +2409,25 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2393,7 +2445,7 @@ "$ref" : "#/components/schemas/FundSource" }, "fundingSource" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", "enum" : [ "debit" @@ -2401,7 +2453,7 @@ "type" : "string" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2410,7 +2462,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2419,17 +2471,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2441,7 +2493,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2455,7 +2507,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2499,12 +2551,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2517,12 +2569,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2530,37 +2582,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -2634,7 +2686,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2685,18 +2737,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -2723,6 +2775,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -2914,6 +2970,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -2959,7 +3026,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -2972,12 +3039,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -3203,7 +3270,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -3322,7 +3389,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3331,13 +3398,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3355,7 +3422,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3369,7 +3436,7 @@ "type" : "string" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3378,7 +3445,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3387,17 +3454,17 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The shopper's phone number.", "type" : "string" } @@ -3455,7 +3522,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3464,13 +3531,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3488,7 +3555,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3498,7 +3565,7 @@ "$ref" : "#/components/schemas/Recurring" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3507,7 +3574,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3516,12 +3583,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The shopper's phone number.", "type" : "string" } @@ -3578,13 +3645,13 @@ "$ref" : "#/components/schemas/Amount" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.", "enum" : [ "NaturalPerson", @@ -3602,7 +3669,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.", "type" : "string" }, @@ -3623,7 +3690,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.", "$ref" : "#/components/schemas/Name" }, @@ -3632,12 +3699,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3682,18 +3749,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -3718,12 +3785,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -3763,7 +3830,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -3784,7 +3851,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -3796,7 +3863,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -3841,7 +3908,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -3850,7 +3917,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -3874,7 +3941,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -3891,13 +3958,6 @@ "originalReference" : "9913140798220028" } }, - "post-confirmThirdParty-confirmThirdParty-200" : { - "summary" : "Example response for request 'confirmThirdParty'", - "value" : { - "pspReference" : "991617894325358C", - "response" : "[payout-confirm-received]" - } - }, "post-declineThirdParty-declineThirdParty" : { "summary" : "Cancel a payout", "description" : "Cancel a previously submitted payout", @@ -3906,13 +3966,6 @@ "originalReference" : "9913140798220028" } }, - "post-declineThirdParty-declineThirdParty-200" : { - "summary" : "Example response for request 'declineThirdParty'", - "value" : { - "pspReference" : "991617894325360J", - "response" : "[payout-decline-received]" - } - }, "post-payout-payout-b2c" : { "summary" : "Instant card payout (B2C)", "description" : "Pay out to your sellers, customers, freelancers, etc", @@ -3991,43 +4044,6 @@ } }, "post-storeDetail-storeDetail" : { - "summary" : "Store payout details", - "description" : "Store payment details under the PAYOUT recurring contract", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "recurring" : { - "contract" : "PAYOUT" - }, - "bank" : { - "bankName" : "AbnAmro", - "bic" : "ABNANL2A", - "countryCode" : "NL", - "iban" : "NL32ABNA0515071439", - "ownerName" : "Adyen", - "bankCity" : "Amsterdam", - "taxId" : "bankTaxId" - }, - "shopperEmail" : "shopper@email.com", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "shopperName" : { - "firstName" : "Adyen", - "gender" : "MALE", - "lastName" : "Test" - }, - "dateOfBirth" : "1990-01-01", - "entityType" : "Company", - "nationality" : "NL", - "billingAddress" : { - "houseNumberOrName" : "17", - "street" : "Teststreet 1", - "city" : "Amsterdam", - "stateOrProvince" : "NY", - "country" : "US", - "postalCode" : "12345" - } - } - }, - "post-storeDetail-storeDetail-200" : { "summary" : "Example response for request 'storeDetail'", "value" : { "pspReference" : "991617894326362D", diff --git a/json/PayoutService-v64.json b/json/PayoutService-v64.json index 0e5b8ab..a6f4a25 100644 --- a/json/PayoutService-v64.json +++ b/json/PayoutService-v64.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Payout/v64" @@ -25,12 +25,25 @@ "paths" : { "/confirmThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Confirms a payout.", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -50,8 +63,8 @@ "content" : { "application/json" : { "examples" : { - "confirmThirdParty-200" : { - "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty-200" + "confirmThirdParty" : { + "$ref" : "#/components/examples/post-confirmThirdParty-confirmThirdParty" } }, "schema" : { @@ -65,8 +78,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -121,12 +134,25 @@ }, "/declineThirdParty" : { "post" : { + "tags" : [ + "Reviewing" + ], "summary" : "Cancels a payout.", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-groupName" : "Reviewing", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -146,8 +172,8 @@ "content" : { "application/json" : { "examples" : { - "declineThirdParty-200" : { - "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty-200" + "declineThirdParty" : { + "$ref" : "#/components/examples/post-declineThirdParty-declineThirdParty" } }, "schema" : { @@ -161,8 +187,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -217,12 +243,25 @@ }, "/payout" : { "post" : { + "tags" : [ + "Instant payouts" + ], "summary" : "Pay out directly.", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", - "x-addedInVersion" : 11, + "x-addedInVersion" : "11", "operationId" : "post-payout", "x-groupName" : "Instant payouts", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -255,8 +294,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -311,11 +350,24 @@ }, "/storeDetail" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores payout details.", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -335,8 +387,8 @@ "content" : { "application/json" : { "examples" : { - "storeDetail-200" : { - "$ref" : "#/components/examples/post-storeDetail-storeDetail-200" + "storeDetail" : { + "$ref" : "#/components/examples/post-storeDetail-storeDetail" } }, "schema" : { @@ -350,8 +402,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -406,12 +458,25 @@ }, "/storeDetailAndSubmitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Stores details and submits a payout.", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -453,8 +518,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -509,12 +574,25 @@ }, "/submitThirdParty" : { "post" : { + "tags" : [ + "Initialization" + ], "summary" : "Submits a payout.", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", - "x-addedInVersion" : 10, + "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-groupName" : "Initialization", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -544,8 +622,8 @@ "content" : { "application/json" : { "examples" : { - "generic-400" : { - "$ref" : "#/components/examples/generic-400" + "generic" : { + "$ref" : "#/components/examples/generic" } }, "schema" : { @@ -635,7 +713,7 @@ "type" : "string" }, "accountType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", "enum" : [ "notApplicable", @@ -983,6 +1061,16 @@ "type" : "string" }, "industryUsage" : { + "x-enum" : [ + { + "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", + "value" : "NoShow" + }, + { + "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", + "value" : "DelayedCharge" + } + ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1241,10 +1329,6 @@ "openinvoicedataLine[itemNr].trackingUri" : { "description" : "URI where the customer can track their shipment.", "type" : "string" - }, - "openinvoicedataLine[itemNr].vatCategory" : { - "description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.", - "type" : "string" } } }, @@ -1470,38 +1554,6 @@ "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", "type" : "string" }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].creditSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccount" : { - "description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : { - "description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementAgency" : { - "description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].debitSettlementBank" : { - "description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits", - "type" : "string" - }, "subMerchant.subSeller[subSellerNr].id" : { "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", "type" : "string" @@ -1689,7 +1741,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -1718,7 +1770,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -1733,41 +1785,41 @@ "type" : "string" }, "colorDepth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", "format" : "int32", "type" : "integer" }, "javaEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", "type" : "boolean" }, "javaScriptEnabled" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "default" : true, "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", "type" : "boolean" }, "language" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", "type" : "string" }, "screenHeight" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total height of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "screenWidth" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The total width of the shopper's device screen in pixels.", "format" : "int32", "type" : "integer" }, "timeZoneOffset" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", "format" : "int32", "type" : "integer" @@ -2041,7 +2093,7 @@ "Installments" : { "properties" : { "plan" : { - "x-addedInVersion" : 64, + "x-addedInVersion" : "64", "description" : "Defines the type of installment plan. If not set, defaults to **regular**.\n\nPossible values:\n* **regular**\n* **revolving**", "enum" : [ "regular", @@ -2257,7 +2309,7 @@ "PayoutRequest" : { "properties" : { "accountInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/AccountInfo" }, @@ -2324,7 +2376,7 @@ "$ref" : "#/components/schemas/Amount" }, "applicationInfo" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "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" }, @@ -2333,7 +2385,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.", "$ref" : "#/components/schemas/Address" }, @@ -2342,7 +2394,7 @@ "$ref" : "#/components/schemas/BrowserInfo" }, "captureDelayHours" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.", "format" : "int32", "type" : "integer" @@ -2352,7 +2404,7 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 7, + "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", "type" : "string" @@ -2366,25 +2418,25 @@ "$ref" : "#/components/schemas/Address" }, "deliveryDate" : { - "x-addedInVersion" : 8, + "x-addedInVersion" : "8", "description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00", "format" : "date-time", "type" : "string" }, "deviceFingerprint" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).", "maxLength" : 5000, "type" : "string" }, "enableRealTimeUpdate" : { - "x-addedInVersion" : 51, + "x-addedInVersion" : "51", "deprecated" : true, "description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.", "type" : "boolean" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payment is processed for.", "enum" : [ "NaturalPerson", @@ -2402,7 +2454,7 @@ "$ref" : "#/components/schemas/FundSource" }, "fundingSource" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", "enum" : [ "debit" @@ -2410,7 +2462,7 @@ "type" : "string" }, "installments" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).", "$ref" : "#/components/schemas/Installments" }, @@ -2419,7 +2471,7 @@ "$ref" : "#/components/schemas/Mandate" }, "mcc" : { - "x-addedInVersion" : 12, + "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.", "type" : "string" }, @@ -2428,17 +2480,17 @@ "type" : "string" }, "merchantOrderReference" : { - "x-addedInVersion" : 9, + "x-addedInVersion" : "9", "description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.", "type" : "string" }, "merchantRiskIndicator" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.", "$ref" : "#/components/schemas/MerchantRiskIndicator" }, "metadata" : { - "x-addedInVersion" : 17, + "x-addedInVersion" : "17", "additionalProperties" : { "type" : "string" }, @@ -2450,7 +2502,7 @@ "$ref" : "#/components/schemas/ThreeDSecureData" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The two-character country code of the shopper's nationality.", "maxLength" : 2, "type" : "string" @@ -2464,7 +2516,7 @@ "$ref" : "#/components/schemas/Recurring" }, "recurringProcessingModel" : { - "x-addedInVersion" : 30, + "x-addedInVersion" : "30", "description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n", "enum" : [ "CardOnFile", @@ -2508,12 +2560,12 @@ "type" : "string" }, "shopperLocale" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The combination of a language code and a country code to specify the language to be used in the payment.", "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's full name.", "$ref" : "#/components/schemas/Name" }, @@ -2526,12 +2578,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The shopper's social security number.", "type" : "string" }, "splits" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" @@ -2539,37 +2591,37 @@ "type" : "array" }, "store" : { - "x-addedInVersion" : 23, - "description" : "The physical store, for which this payment is processed.", + "x-addedInVersion" : "23", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 7, + "x-addedInVersion" : "7", "description" : "The shopper's telephone number.", "type" : "string" }, "threeDS2RequestData" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.", "$ref" : "#/components/schemas/ThreeDS2RequestData" }, "threeDSAuthenticationOnly" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "default" : false, "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.", "type" : "boolean" }, "totalsGroup" : { - "x-addedInVersion" : 23, + "x-addedInVersion" : "23", "description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).", "maxLength" : 16, "minLength" : 1, "type" : "string" }, "trustedShopper" : { - "x-addedInVersion" : 37, + "x-addedInVersion" : "37", "description" : "Set to true if the payment should be routed to a trusted MID.", "type" : "boolean" } @@ -2643,7 +2695,7 @@ }, "md" : { "description" : "The payment session.", - "maxLength" : 10000, + "maxLength" : 20000, "type" : "string" }, "paRequest" : { @@ -2694,18 +2746,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -2732,6 +2784,10 @@ "scaExemptionRequested" : { "description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type" : "string" + }, + "threeds2.cardEnrolled" : { + "description" : "Indicates whether a card is enrolled for 3D Secure 2.", + "type" : "boolean" } } }, @@ -2923,6 +2979,17 @@ "description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type" : "string" }, + "merchantAdviceCode" : { + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], + "type" : "string" + }, "merchantReference" : { "description" : "The reference provided for the transaction.", "type" : "string" @@ -2968,7 +3035,7 @@ "type" : "string" }, "recurring.contractTypes" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The recurring contract types applicable to the transaction.", "type" : "string" }, @@ -2981,12 +3048,12 @@ "type" : "string" }, "recurring.shopperReference" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The provided reference of the shopper for a recurring transaction.", "type" : "string" }, "recurringProcessingModel" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The processing model used for the recurring transaction.", "enum" : [ "CardOnFile", @@ -3212,7 +3279,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, @@ -3331,7 +3398,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3340,13 +3407,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3364,7 +3431,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3378,7 +3445,7 @@ "type" : "string" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3387,7 +3454,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3396,17 +3463,17 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The shopper's phone number.", "type" : "string" } @@ -3464,7 +3531,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -3473,13 +3540,13 @@ "$ref" : "#/components/schemas/Card" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n> This field is mandatory for natural persons.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.", "enum" : [ "NaturalPerson", @@ -3497,7 +3564,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').", "maxLength" : 2, "type" : "string" @@ -3507,7 +3574,7 @@ "$ref" : "#/components/schemas/Recurring" }, "selectedBrand" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The name of the brand to make a payout to.\n\nFor Paysafecard it must be set to `paysafecard`.", "type" : "string" }, @@ -3516,7 +3583,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nWhen the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.", "$ref" : "#/components/schemas/Name" }, @@ -3525,12 +3592,12 @@ "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" }, "telephoneNumber" : { - "x-addedInVersion" : 52, + "x-addedInVersion" : "52", "description" : "The shopper's phone number.", "type" : "string" } @@ -3587,13 +3654,13 @@ "$ref" : "#/components/schemas/Amount" }, "dateOfBirth" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\nFor Paysafecard it must be the same as used when registering the Paysafecard account.\n\n> This field is mandatory for natural persons. \n> This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.", "format" : "date-time", "type" : "string" }, "entityType" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The type of the entity the payout is processed for.\n\nAllowed values:\n* NaturalPerson\n* Company\n> This field is required to update the existing `entityType` that is associated with this recurring contract.", "enum" : [ "NaturalPerson", @@ -3611,7 +3678,7 @@ "type" : "string" }, "nationality" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's nationality.\n\nA valid value is an ISO 2-character country code (e.g. 'NL').\n\n> This field is required to update the existing nationality that is associated with this recurring contract.", "type" : "string" }, @@ -3632,7 +3699,7 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's name.\n\nIn case the `entityType` is `Company`, the `shopperName.lastName` must contain the company name.\n\n> This field is required to update the existing `shopperName` associated with a recurring contract.", "$ref" : "#/components/schemas/Name" }, @@ -3641,12 +3708,12 @@ "type" : "string" }, "shopperStatement" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).", "type" : "string" }, "socialSecurityNumber" : { - "x-addedInVersion" : 24, + "x-addedInVersion" : "24", "description" : "The shopper's social security number.", "type" : "string" } @@ -3691,18 +3758,18 @@ "ThreeDS2RequestData" : { "properties" : { "acquirerBIN" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "acquirerMerchantID" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", "type" : "string" }, "authenticationOnly" : { "deprecated" : true, - "x-deprecatedInVersion" : 50, + "x-deprecatedInVersion" : "50", "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", "default" : false, "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.", @@ -3727,12 +3794,12 @@ "$ref" : "#/components/schemas/DeviceRenderOptions" }, "mcc" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", "type" : "string" }, "merchantName" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", "type" : "string" }, @@ -3772,7 +3839,7 @@ "type" : "string" }, "sdkVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", "type" : "string" }, @@ -3793,7 +3860,7 @@ "type" : "string" }, "transactionType" : { - "x-addedInVersion" : 50, + "x-addedInVersion" : "50", "description" : "Identify the type of the transaction being authenticated.", "enum" : [ "goodsOrServicePurchase", @@ -3805,7 +3872,7 @@ "type" : "string" }, "whiteListStatus" : { - "x-addedInVersion" : 49, + "x-addedInVersion" : "49", "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", "type" : "string" } @@ -3850,7 +3917,7 @@ "type" : "string" }, "dsTransID" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", "type" : "string" }, @@ -3859,7 +3926,7 @@ "type" : "string" }, "threeDSVersion" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "The version of the 3D Secure protocol.", "type" : "string" }, @@ -3883,7 +3950,7 @@ } }, "examples" : { - "generic-400" : { + "generic" : { "summary" : "Response code 400. Bad Request.", "value" : { "status" : 400, @@ -3900,13 +3967,6 @@ "originalReference" : "9913140798220028" } }, - "post-confirmThirdParty-confirmThirdParty-200" : { - "summary" : "Example response for request 'confirmThirdParty'", - "value" : { - "pspReference" : "991617894325358C", - "response" : "[payout-confirm-received]" - } - }, "post-declineThirdParty-declineThirdParty" : { "summary" : "Cancel a payout", "description" : "Cancel a previously submitted payout", @@ -3915,13 +3975,6 @@ "originalReference" : "9913140798220028" } }, - "post-declineThirdParty-declineThirdParty-200" : { - "summary" : "Example response for request 'declineThirdParty'", - "value" : { - "pspReference" : "991617894325360J", - "response" : "[payout-decline-received]" - } - }, "post-payout-payout-b2c" : { "summary" : "Instant card payout (B2C)", "description" : "Pay out to your sellers, customers, freelancers, etc", @@ -4000,43 +4053,6 @@ } }, "post-storeDetail-storeDetail" : { - "summary" : "Store payout details", - "description" : "Store payment details under the PAYOUT recurring contract", - "value" : { - "merchantAccount" : "YOUR_MERCHANT_ACCOUNT", - "recurring" : { - "contract" : "PAYOUT" - }, - "bank" : { - "bankName" : "AbnAmro", - "bic" : "ABNANL2A", - "countryCode" : "NL", - "iban" : "NL32ABNA0515071439", - "ownerName" : "Adyen", - "bankCity" : "Amsterdam", - "taxId" : "bankTaxId" - }, - "shopperEmail" : "shopper@email.com", - "shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j", - "shopperName" : { - "firstName" : "Adyen", - "gender" : "MALE", - "lastName" : "Test" - }, - "dateOfBirth" : "1990-01-01", - "entityType" : "Company", - "nationality" : "NL", - "billingAddress" : { - "houseNumberOrName" : "17", - "street" : "Teststreet 1", - "city" : "Amsterdam", - "stateOrProvince" : "NY", - "country" : "US", - "postalCode" : "12345" - } - } - }, - "post-storeDetail-storeDetail-200" : { "summary" : "Example response for request 'storeDetail'", "value" : { "pspReference" : "991617894326362D", diff --git a/json/RecurringService-v25.json b/json/RecurringService-v25.json index 633b81f..2041528 100644 --- a/json/RecurringService-v25.json +++ b/json/RecurringService-v25.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Recurring/v25" @@ -23,11 +23,24 @@ "paths" : { "/disable" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disables stored payment details.", "description" : "Disables stored payment details to stop charging a shopper with this particular recurring detail ID.\n\nFor more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", "operationId" : "post-disable", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -108,11 +121,24 @@ }, "/listRecurringDetails" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves stored payment details for a shopper.", "description" : "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.\n\nFor more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", "operationId" : "post-listRecurringDetails", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -193,12 +219,25 @@ }, "/scheduleAccountUpdater" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Schedules running of the Account Updater.", "description" : "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:\n* If the card information is provided, all the sub-fields for `card` are mandatory.\n* If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "operationId" : "post-scheduleAccountUpdater", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -344,7 +383,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -373,7 +412,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -440,7 +479,7 @@ "DisableRequest" : { "properties" : { "contract" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Specify the contract if you only want to disable a specific use.\n\nThis field can be set to one of the following values, or to their combination (comma-separated):\n* ONECLICK\n* RECURRING\n* PAYOUT", "type" : "string" }, @@ -502,7 +541,7 @@ "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -515,7 +554,7 @@ "RecurringDetail" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -523,12 +562,12 @@ "type" : "object" }, "alias" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details", "type" : "string" }, "aliasType" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.", "type" : "string" }, @@ -537,7 +576,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -546,7 +585,7 @@ "$ref" : "#/components/schemas/Card" }, "contractTypes" : { - "x-addedInVersion" : 12, + "x-addedInVersion" : "12", "description" : "Types of recurring contracts.", "items" : { "type" : "string" @@ -559,7 +598,7 @@ "type" : "string" }, "firstPspReference" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The `pspReference` of the first recurring payment that created the recurring detail.", "type" : "string" }, @@ -568,7 +607,7 @@ "type" : "string" }, "paymentMethodVariant" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).", "type" : "string" }, @@ -577,12 +616,12 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The name of the shopper.", "$ref" : "#/components/schemas/Name" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A shopper's social security number (only in countries where it is legal to collect).", "type" : "string" }, diff --git a/json/RecurringService-v30.json b/json/RecurringService-v30.json index 0a57516..fbc5606 100644 --- a/json/RecurringService-v30.json +++ b/json/RecurringService-v30.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Recurring/v30" @@ -23,11 +23,24 @@ "paths" : { "/disable" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disables stored payment details.", "description" : "Disables stored payment details to stop charging a shopper with this particular recurring detail ID.\n\nFor more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", "operationId" : "post-disable", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -108,11 +121,24 @@ }, "/listRecurringDetails" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves stored payment details for a shopper.", "description" : "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.\n\nFor more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", "operationId" : "post-listRecurringDetails", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -193,12 +219,25 @@ }, "/scheduleAccountUpdater" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Schedules running of the Account Updater.", "description" : "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:\n* If the card information is provided, all the sub-fields for `card` are mandatory.\n* If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "operationId" : "post-scheduleAccountUpdater", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -344,7 +383,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -373,7 +412,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -440,7 +479,7 @@ "DisableRequest" : { "properties" : { "contract" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Specify the contract if you only want to disable a specific use.\n\nThis field can be set to one of the following values, or to their combination (comma-separated):\n* ONECLICK\n* RECURRING\n* PAYOUT", "type" : "string" }, @@ -502,7 +541,7 @@ "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -515,7 +554,7 @@ "RecurringDetail" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -523,12 +562,12 @@ "type" : "object" }, "alias" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details", "type" : "string" }, "aliasType" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.", "type" : "string" }, @@ -537,7 +576,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -546,7 +585,7 @@ "$ref" : "#/components/schemas/Card" }, "contractTypes" : { - "x-addedInVersion" : 12, + "x-addedInVersion" : "12", "description" : "Types of recurring contracts.", "items" : { "type" : "string" @@ -559,7 +598,7 @@ "type" : "string" }, "firstPspReference" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The `pspReference` of the first recurring payment that created the recurring detail.", "type" : "string" }, @@ -568,7 +607,7 @@ "type" : "string" }, "paymentMethodVariant" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).", "type" : "string" }, @@ -577,12 +616,12 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The name of the shopper.", "$ref" : "#/components/schemas/Name" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A shopper's social security number (only in countries where it is legal to collect).", "type" : "string" }, diff --git a/json/RecurringService-v40.json b/json/RecurringService-v40.json index 95d3579..e0e9a84 100644 --- a/json/RecurringService-v40.json +++ b/json/RecurringService-v40.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Recurring/v40" @@ -23,11 +23,24 @@ "paths" : { "/disable" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disables stored payment details.", "description" : "Disables stored payment details to stop charging a shopper with this particular recurring detail ID.\n\nFor more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", "operationId" : "post-disable", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -108,11 +121,24 @@ }, "/listRecurringDetails" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves stored payment details for a shopper.", "description" : "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.\n\nFor more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", "operationId" : "post-listRecurringDetails", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -193,12 +219,25 @@ }, "/scheduleAccountUpdater" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Schedules running of the Account Updater.", "description" : "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:\n* If the card information is provided, all the sub-fields for `card` are mandatory.\n* If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "operationId" : "post-scheduleAccountUpdater", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -344,7 +383,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -373,7 +412,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -440,7 +479,7 @@ "DisableRequest" : { "properties" : { "contract" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Specify the contract if you only want to disable a specific use.\n\nThis field can be set to one of the following values, or to their combination (comma-separated):\n* ONECLICK\n* RECURRING\n* PAYOUT", "type" : "string" }, @@ -502,18 +541,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -526,7 +565,7 @@ "RecurringDetail" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -534,12 +573,12 @@ "type" : "object" }, "alias" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details", "type" : "string" }, "aliasType" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.", "type" : "string" }, @@ -548,7 +587,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -557,7 +596,7 @@ "$ref" : "#/components/schemas/Card" }, "contractTypes" : { - "x-addedInVersion" : 12, + "x-addedInVersion" : "12", "description" : "Types of recurring contracts.", "items" : { "type" : "string" @@ -570,7 +609,7 @@ "type" : "string" }, "firstPspReference" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The `pspReference` of the first recurring payment that created the recurring detail.", "type" : "string" }, @@ -579,7 +618,7 @@ "type" : "string" }, "paymentMethodVariant" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).", "type" : "string" }, @@ -588,12 +627,12 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The name of the shopper.", "$ref" : "#/components/schemas/Name" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A shopper's social security number (only in countries where it is legal to collect).", "type" : "string" }, diff --git a/json/RecurringService-v49.json b/json/RecurringService-v49.json index 4c35bc7..bc1b410 100644 --- a/json/RecurringService-v49.json +++ b/json/RecurringService-v49.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/Recurring/v49" @@ -23,11 +23,24 @@ "paths" : { "/disable" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Disables stored payment details.", "description" : "Disables stored payment details to stop charging a shopper with this particular recurring detail ID.\n\nFor more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", "operationId" : "post-disable", "x-groupName" : "General", "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -108,11 +121,24 @@ }, "/listRecurringDetails" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Retrieves stored payment details for a shopper.", "description" : "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper.\n\nFor more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", "operationId" : "post-listRecurringDetails", "x-groupName" : "General", "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -193,12 +219,25 @@ }, "/scheduleAccountUpdater" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Schedules running of the Account Updater.", "description" : "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference:\n* If the card information is provided, all the sub-fields for `card` are mandatory.\n* If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "operationId" : "post-scheduleAccountUpdater", "x-groupName" : "General", "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { @@ -344,7 +383,7 @@ "type" : "string" }, "bankCity" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank city.", "type" : "string" }, @@ -373,7 +412,7 @@ "type" : "string" }, "taxId" : { - "x-addedInVersion" : 18, + "x-addedInVersion" : "18", "description" : "The bank account holder's tax ID.", "type" : "string" } @@ -440,7 +479,7 @@ "DisableRequest" : { "properties" : { "contract" : { - "x-addedInVersion" : 3, + "x-addedInVersion" : "3", "description" : "Specify the contract if you only want to disable a specific use.\n\nThis field can be set to one of the following values, or to their combination (comma-separated):\n* ONECLICK\n* RECURRING\n* PAYOUT", "type" : "string" }, @@ -502,18 +541,18 @@ "type" : "string" }, "recurringExpiry" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.", "format" : "date-time", "type" : "string" }, "recurringFrequency" : { - "x-addedInVersion" : 40, + "x-addedInVersion" : "40", "description" : "Minimum number of days between authorisations. Only for 3D Secure 2.", "type" : "string" }, "tokenService" : { - "x-addedInVersion" : 25, + "x-addedInVersion" : "25", "description" : "The name of the token service.", "enum" : [ "VISATOKENSERVICE", @@ -526,7 +565,7 @@ "RecurringDetail" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 5, + "x-addedInVersion" : "5", "additionalProperties" : { "type" : "string" }, @@ -534,12 +573,12 @@ "type" : "object" }, "alias" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details", "type" : "string" }, "aliasType" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.", "type" : "string" }, @@ -548,7 +587,7 @@ "$ref" : "#/components/schemas/BankAccount" }, "billingAddress" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The billing address.", "$ref" : "#/components/schemas/Address" }, @@ -557,7 +596,7 @@ "$ref" : "#/components/schemas/Card" }, "contractTypes" : { - "x-addedInVersion" : 12, + "x-addedInVersion" : "12", "description" : "Types of recurring contracts.", "items" : { "type" : "string" @@ -570,7 +609,7 @@ "type" : "string" }, "firstPspReference" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The `pspReference` of the first recurring payment that created the recurring detail.", "type" : "string" }, @@ -579,7 +618,7 @@ "type" : "string" }, "paymentMethodVariant" : { - "x-addedInVersion" : 2, + "x-addedInVersion" : "2", "description" : "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).", "type" : "string" }, @@ -588,12 +627,12 @@ "type" : "string" }, "shopperName" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "The name of the shopper.", "$ref" : "#/components/schemas/Name" }, "socialSecurityNumber" : { - "x-addedInVersion" : 4, + "x-addedInVersion" : "4", "description" : "A shopper's social security number (only in countries where it is legal to collect).", "type" : "string" }, @@ -705,7 +744,7 @@ "ServiceError" : { "properties" : { "additionalData" : { - "x-addedInVersion" : 46, + "x-addedInVersion" : "46", "additionalProperties" : { "type" : "string" }, diff --git a/json/TestCardService-v1.json b/json/TestCardService-v1.json index e8abc9c..fa50a00 100644 --- a/json/TestCardService-v1.json +++ b/json/TestCardService-v1.json @@ -1,5 +1,5 @@ { - "openapi" : "3.0.3", + "openapi" : "3.1.0", "servers" : [ { "url" : "https://pal-test.adyen.com/pal/services/TestCard/v1" @@ -23,11 +23,24 @@ "paths" : { "/createTestCardRanges" : { "post" : { + "tags" : [ + "General" + ], "summary" : "Creates one or more test card ranges.", "description" : "Creates one or more test card ranges.", "operationId" : "post-createTestCardRanges", "x-groupName" : "General", "x-sortIndex" : 0, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], "requestBody" : { "content" : { "application/json" : { diff --git a/json/Webhooks-v1.json b/json/Webhooks-v1.json new file mode 100644 index 0000000..2127cf0 --- /dev/null +++ b/json/Webhooks-v1.json @@ -0,0 +1,3315 @@ +{ + "openapi" : "3.1.0", + "info" : { + "version" : "1", + "x-publicVersion" : true, + "title" : "Notifications", + "description" : "Our notifications are webhooks informing you of payment status updates and newly available reports. For more information, refer to our [documentation](https://docs.adyen.com/development-resources/webhooks).", + "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", + "contact" : { + "name" : "Adyen Developer Experience team", + "url" : "https://www.adyen.help/hc/en-us/community/topics", + "email" : "developer-experience@adyen.com" + } + }, + "x-groups" : [ + "standard", + "additional configuration", + "dispute", + "payout" + ], + "x-staticResponse" : "response.json", + "webhooks" : { + "/AUTHORISATION" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of payment request.", + "description" : "Informs you of the outcome of payment request.", + "operationId" : "post-AUTHORISATION", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "authorisation" : { + "$ref" : "#/components/examples/post-AUTHORISATION-authorisation" + } + }, + "schema" : { + "$ref" : "#/components/schemas/AuthorisationNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "authorisation" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/AUTHORISATION_ADJUSTMENT" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to adjust the authorised amount.", + "description" : "Informs you of the outcome of a request to [adjust the authorised amount](https://docs.adyen.com/online-payments/adjust-authorisation) sent through the [/adjustAuthorisation](https://docs.adyen.com/api-explorer/#/Payment/latest/post/adjustAuthorisation) endpoint.", + "operationId" : "post-AUTHORISATION_ADJUSTMENT", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "authorisation_adjustment" : { + "$ref" : "#/components/examples/post-AUTHORISATION_ADJUSTMENT-authorisation_adjustment" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "authorisation_adjustment" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/AUTORESCUE" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that an Auto Rescue process has ended.", + "description" : "Informs you that an [Auto Rescue process](https://docs.adyen.com/online-payments/auto-rescue#rescue-process-ended) has ended.", + "operationId" : "post-AUTORESCUE", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "autorescue" : { + "$ref" : "#/components/examples/post-AUTORESCUE-autorescue" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "autorescue" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CANCELLATION" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to cancel a payment.", + "description" : "Informs you of the outcome of a request to [cancel a payment](https://docs.adyen.com/online-payments/cancel).", + "operationId" : "post-CANCELLATION", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "cancellation" : { + "$ref" : "#/components/examples/post-CANCELLATION-cancellation" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "cancellation" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CANCEL_AUTORESCUE" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that an Auto Rescue cancel request has been processed.", + "description" : "Informs you that an [Auto Rescue cancel request](https://docs.adyen.com/online-payments/auto-rescue#cancel-auto-rescue-process) has been processed.", + "operationId" : "post-CANCEL_AUTORESCUE", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "cancel_autorescue" : { + "$ref" : "#/components/examples/post-CANCEL_AUTORESCUE-cancel_autorescue" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "cancel_autorescue" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CANCEL_OR_REFUND" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to cancel or refund a payment.", + "description" : "Informs you of the outcome of a request to [cancel or refund a payment](https://docs.adyen.com/online-payments/cancel-or-refund).", + "operationId" : "post-CANCEL_OR_REFUND", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "cancel_or_refund" : { + "$ref" : "#/components/examples/post-CANCEL_OR_REFUND-cancel_or_refund" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "cancel_or_refund" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CAPTURE" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to capture a payment.", + "description" : "Informs you of the outcome of a request to [capture a payment](https://docs.adyen.com/online-payments/capture).", + "operationId" : "post-CAPTURE", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "capture" : { + "$ref" : "#/components/examples/post-CAPTURE-capture" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "capture" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CAPTURE_FAILED" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you about a failed capture.", + "description" : "Informs you about a failed capture due to a [technical issue](https://docs.adyen.com/online-payments/capture#failed-capture).", + "operationId" : "post-CAPTURE_FAILED", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "capture_failed" : { + "$ref" : "#/components/examples/post-CAPTURE_FAILED-capture_failed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "capture_failed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CHARGEBACK" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that a payment was charged back, and the funds were deducted from your account.", + "description" : "Informs you that a payment was [charged back](https://docs.adyen.com/risk-management/disputes-api/dispute-notifications#chargeback), and the funds were deducted from your account.", + "operationId" : "post-CHARGEBACK", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "chargeback" : { + "$ref" : "#/components/examples/post-CHARGEBACK-chargeback" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "chargeback" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/CHARGEBACK_REVERSED" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that a chargeback has been defended towards the issuing bank.", + "description" : "Informs you that a chargeback has been defended towards the issuing bank. This stage is not final. If the issuing bank decides to present a second chargeback, you might still lose the chargeback case.", + "operationId" : "post-CHARGEBACK_REVERSED", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "chargeback_reversed" : { + "$ref" : "#/components/examples/post-CHARGEBACK_REVERSED-chargeback_reversed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "chargeback_reversed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/MANUAL_REVIEW_ACCEPT" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that the manual review has been accepted.", + "description" : "Informs you that the manual review has been accepted.", + "operationId" : "post-MANUAL_REVIEW_ACCEPT", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "manual_review_accept" : { + "$ref" : "#/components/examples/post-MANUAL_REVIEW_ACCEPT-manual_review_accept" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "manual_review_accept" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/MANUAL_REVIEW_REJECT" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that the manual review has been rejected.", + "description" : "Informs you that the manual review has been rejected.", + "operationId" : "post-MANUAL_REVIEW_REJECT", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "manual_review_reject" : { + "$ref" : "#/components/examples/post-MANUAL_REVIEW_REJECT-manual_review_reject" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "manual_review_reject" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/NOTIFICATION_OF_CHARGEBACK" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that the dispute process has been opened.", + "description" : "Informs you that the dispute process has been opened. You should investigate the dispute and [supply the defense documents](https://docs.adyen.com/risk-management/disputes-api#supply-dispute-defense-documents).", + "operationId" : "post-NOTIFICATION_OF_CHARGEBACK", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "notification_of_chargeback" : { + "$ref" : "#/components/examples/post-NOTIFICATION_OF_CHARGEBACK-notification_of_chargeback" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "notification_of_chargeback" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/NOTIFICATION_OF_FRAUD" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "The alert notification passed on by issuers to schemes and subsequently to processors.", + "description" : "The alert notification passed on by issuers to schemes and subsequently to processors. Visa calls them TC40 and Mastercard calls them System to Avoid Fraud Effectively (SAFE). These are informational notifications offered by Adyen, providing you the opportunity to take action, such as blocking a shopper or issuing a refund before a chargeback is incurred.", + "operationId" : "post-NOTIFICATION_OF_FRAUD", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "notification_of_fraud" : { + "$ref" : "#/components/examples/post-NOTIFICATION_OF_FRAUD-notification_of_fraud" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "notification_of_fraud" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/OFFER_CLOSED" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that the offer has expired.", + "description" : "Informs you that the offer has expired, for example because the shopper abandoned the session. For cards, offers expire after 12 hours by default.", + "operationId" : "post-OFFER_CLOSED", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "offer_closed" : { + "$ref" : "#/components/examples/post-OFFER_CLOSED-offer_closed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "offer_closed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/ORDER_CLOSED" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a shopper's last payment when paying for an order in partial payments.", + "description" : "Informs you of the outcome of a shopper's last payment when paying for an order in [partial payments](https://docs.adyen.com/online-payments/classic-integrations/hosted-payment-pages/payment-request/partial-payments#notifications).", + "operationId" : "post-ORDER_CLOSED", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "order_closed" : { + "$ref" : "#/components/examples/post-ORDER_CLOSED-order_closed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "order_closed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/ORDER_OPENED" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you that the first payment for your payment request is a partial payment, and an order has been created.", + "description" : "Informs you that the first payment for your payment request is a [partial payment](https://docs.adyen.com/online-payments/classic-integrations/hosted-payment-pages/payment-request/partial-payments#notifications), and an order has been created.", + "operationId" : "post-ORDER_OPENED", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "order_opened" : { + "$ref" : "#/components/examples/post-ORDER_OPENED-order_opened" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "order_opened" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/PAIDOUT_REVERSED" : { + "post" : { + "tags" : [ + "payout" + ], + "summary" : "Informs you that the financial institution has rejected the payout.", + "description" : "Informs you that the financial institution has rejected the payout. We will return the funds back to your account. \nThe reason field contains the bank statement description if present.", + "operationId" : "post-PAIDOUT_REVERSED", + "x-groupName" : "payout", + "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "paidout_reversed" : { + "$ref" : "#/components/examples/post-PAIDOUT_REVERSED-paidout_reversed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PaidoutReversedNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "paidout_reversed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/PAYOUT_DECLINE" : { + "post" : { + "tags" : [ + "payout" + ], + "summary" : "Informs you that the user reviewing the payout has declined it.", + "description" : "Informs you that the user reviewing the payout has [declined](https://docs.adyen.com/online-payments/online-payouts/confirm-or-decline-payout) it.", + "operationId" : "post-PAYOUT_DECLINE", + "x-groupName" : "payout", + "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "payout_decline" : { + "$ref" : "#/components/examples/post-PAYOUT_DECLINE-payout_decline" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "payout_decline" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/PAYOUT_EXPIRE" : { + "post" : { + "tags" : [ + "payout" + ], + "summary" : "Informs you that the payout has expired.", + "description" : "Informs you that the [payout has expired](https://docs.adyen.com/online-payments/online-payouts/payout-notifications).", + "operationId" : "post-PAYOUT_EXPIRE", + "x-groupName" : "payout", + "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "payout_expire" : { + "$ref" : "#/components/examples/post-PAYOUT_EXPIRE-payout_expire" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "payout_expire" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/PAYOUT_THIRDPARTY" : { + "post" : { + "tags" : [ + "payout" + ], + "summary" : "Informs you of the outcome of a payout request.", + "description" : "Informs you of the outcome of a payout request.", + "operationId" : "post-PAYOUT_THIRDPARTY", + "x-groupName" : "payout", + "x-sortIndex" : 3, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "payout_thirdparty" : { + "$ref" : "#/components/examples/post-PAYOUT_THIRDPARTY-payout_thirdparty" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "payout_thirdparty" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/POSTPONED_REFUND" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that the refund for the payment will be performed after the payment is captured.", + "description" : "Informs you that the refund for the payment will be performed after the payment is captured.", + "operationId" : "post-POSTPONED_REFUND", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "postponed_refund" : { + "$ref" : "#/components/examples/post-POSTPONED_REFUND-postponed_refund" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "postponed_refund" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/PREARBITRATION_LOST" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that your pre-arbitration case has been declined by the cardholder's bank.", + "description" : "Informs you that your pre-arbitration case has been declined by the cardholder's bank.", + "operationId" : "post-PREARBITRATION_LOST", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "prearbitration_lost" : { + "$ref" : "#/components/examples/post-PREARBITRATION_LOST-prearbitration_lost" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "prearbitration_lost" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/PREARBITRATION_WON" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that your pre-arbitration case has been accepted by the cardholder's bank.", + "description" : "Informs you that your pre-arbitration case has been accepted by the cardholder's bank.", + "operationId" : "post-PREARBITRATION_WON", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "prearbitration_won" : { + "$ref" : "#/components/examples/post-PREARBITRATION_WON-prearbitration_won" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "prearbitration_won" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/RECURRING_CONTRACT" : { + "post" : { + "tags" : [ + "additional configuration" + ], + "summary" : "Informs you that a recurring contract has been created.", + "description" : "Informs you that a recurring contract has been created.", + "operationId" : "post-RECURRING_CONTRACT", + "x-groupName" : "additional configuration", + "x-sortIndex" : 4, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "recurring_contract" : { + "$ref" : "#/components/examples/post-RECURRING_CONTRACT-recurring_contract" + } + }, + "schema" : { + "$ref" : "#/components/schemas/RecurringContractNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "recurring_contract" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/REFUND" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to refund a payment.", + "description" : "Informs you of the outcome of a request to [refund a payment](https://docs.adyen.com/online-payments/refund).", + "operationId" : "post-REFUND", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "refund" : { + "$ref" : "#/components/examples/post-REFUND-refund" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "refund" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/REFUND_FAILED" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you that the refund failed due to a technical issue.", + "description" : "Informs you that the refund failed due to a [technical issue](https://docs.adyen.com/online-payments/refund#failed-refund).", + "operationId" : "post-REFUND_FAILED", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "refund_failed" : { + "$ref" : "#/components/examples/post-REFUND_FAILED-refund_failed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "refund_failed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/REFUND_REVERSED" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you that the refunded amount has been returned to Adyen, and is back in your account.", + "description" : "Informs you that the refunded amount has been returned to Adyen, and is back in your account.", + "operationId" : "post-REFUND_REVERSED", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "refund_reversed" : { + "$ref" : "#/components/examples/post-REFUND_REVERSED-refund_reversed" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "refund_reversed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/REFUND_WITH_DATA" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to refund with data.", + "description" : "Informs you of the outcome of a request to [refund with data](https://docs.adyen.com/online-payments/refund#unreferenced-refund).", + "operationId" : "post-REFUND_WITH_DATA", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "refund_with_data" : { + "$ref" : "#/components/examples/post-REFUND_WITH_DATA-refund_with_data" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "refund_with_data" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/REPORT_AVAILABLE" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you that a new report is available.", + "description" : "Informs you that a [new report](https://docs.adyen.com/reporting/downloading-reports#automate-downloading-reports) is available.", + "operationId" : "post-REPORT_AVAILABLE", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "report_available" : { + "$ref" : "#/components/examples/post-REPORT_AVAILABLE-report_available" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ReportAvailableNotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "report_available" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/REQUEST_FOR_INFORMATION" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that a shopper has opened an RFI.", + "description" : "Informs you that a shopper has opened an RFI (Request for Information) case with the bank. You should [supply defense documents](https://docs.adyen.com/risk-management/disputes-api#supply-dispute-defense-documents) to help shopper understand the charge.", + "operationId" : "post-REQUEST_FOR_INFORMATION", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "request_for_information" : { + "$ref" : "#/components/examples/post-REQUEST_FOR_INFORMATION-request_for_information" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "request_for_information" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/SECOND_CHARGEBACK" : { + "post" : { + "tags" : [ + "dispute" + ], + "summary" : "Informs you that the issuing bank has declined the defense documents.", + "description" : "Informs you that the issuing bank has declined the material submitted during defense of the original chargeback. The disputed amount is deducted from your account.", + "operationId" : "post-SECOND_CHARGEBACK", + "x-groupName" : "dispute", + "x-sortIndex" : 2, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "second_chargeback" : { + "$ref" : "#/components/examples/post-SECOND_CHARGEBACK-second_chargeback" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "second_chargeback" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/TECHNICAL_CANCEL" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of the technical cancel request.", + "description" : "Informs you of the outcome of the [technical cancel](https://docs.adyen.com/online-payments/cancel#technical-cancel) request.", + "operationId" : "post-TECHNICAL_CANCEL", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "technical_cancel" : { + "$ref" : "#/components/examples/post-TECHNICAL_CANCEL-technical_cancel" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "technical_cancel" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + }, + "/VOID_PENDING_REFUND" : { + "post" : { + "tags" : [ + "standard" + ], + "summary" : "Informs you of the outcome of a request to cancel a POS refund.", + "description" : "Informs you of the outcome of a request to [cancel a POS refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).", + "operationId" : "post-VOID_PENDING_REFUND", + "x-groupName" : "standard", + "x-sortIndex" : 1, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "void_pending_refund" : { + "$ref" : "#/components/examples/post-VOID_PENDING_REFUND-void_pending_refund" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "void_pending_refund" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, + "schema" : { + "$ref" : "#/components/schemas/NotificationResponse" + } + } + }, + "description" : "OK - the request has succeeded." + } + } + } + } + }, + "components" : { + "schemas" : { + "Amount" : { + "properties" : { + "currency" : { + "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", + "maxLength" : 3, + "minLength" : 3, + "type" : "string" + }, + "value" : { + "description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", + "format" : "int64", + "type" : "integer" + } + }, + "required" : [ + "value", + "currency" + ] + }, + "AuthorisationNotificationAdditionalData" : { + "properties" : { + "authCode" : { + "description" : "When the payment is authorised successfully, this fields holds the authorisation code for the payment, otherwise it's empty.", + "type" : "string" + }, + "authorisedAmountCurrency" : { + "description" : "Currency of the authorised amount.", + "type" : "string" + }, + "authorisedAmountValue" : { + "description" : "Value of the amount authorised. : a bunch more information", + "type" : "string" + }, + "cardSummary" : { + "description" : "Returns the last 4 digits of the credit card.", + "type" : "string" + }, + "expiryDate" : { + "description" : "Returns the card expiry date.", + "type" : "string" + }, + "iDealConsumerAccountNumber" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + }, + "iDealConsumerBIC" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + }, + "iDealConsumerCity" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + }, + "iDealConsumerIBAN" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + }, + "iDealConsumerIban" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + }, + "iDealConsumerName" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + }, + "iDealTransactionId" : { + "description" : "Only included for iDeal payments.", + "type" : "string" + } + } + }, + "AuthorisationNotificationRequest" : { + "properties" : { + "live" : { + "description" : "Informs about the origin of the notification. The value is `true` when originating from the live environment, `false` for the test environment.", + "type" : "boolean" + }, + "notificationItems" : { + "description" : "A container object for the details included in the notification.", + "items" : { + "$ref" : "#/components/schemas/AuthorisationNotificationRequestItem" + }, + "type" : "array" + } + } + }, + "AuthorisationNotificationRequestItem" : { + "properties" : { + "additionalData" : { + "description" : "This object is a generic container that can hold extra fields.", + "$ref" : "#/components/schemas/AuthorisationNotificationAdditionalData" + }, + "amount" : { + "description" : "A container object vor the payable amount information for the transaction. For HTTP POST notifications, currency and value are returned as URL parameters.", + "$ref" : "#/components/schemas/Amount" + }, + "eventCode" : { + "description" : "The type of event the notification item refers to. : This equals the name of the 'endpoint'.", + "type" : "string" + }, + "eventDate" : { + "description" : "The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD", + "example" : "2021-07-17T13:42:40+01:00", + "format" : "date-time", + "type" : "string" + }, + "merchantAccountCode" : { + "description" : "The merchant account identifier used in the transaction the notification item refers to.", + "type" : "string" + }, + "merchantReference" : { + "description" : "A reference to uniquely identify the payment. ", + "type" : "string" + }, + "operations" : { + "description" : "The operations indicate the supported follow-up actions concerning the payment.\n> This is an **experimental field**. Do not base your code on this field. Not all specific cases are covered yet. It's possible that the field is empty or contains generic information.", + "enum" : [ + "CAPTURE", + "CANCEL", + "REFUND" + ], + "items" : { + "type" : "string" + }, + "type" : "string" + }, + "paymentMethod" : { + "description" : "The payment method used in the transaction.", + "example" : "visa, mc, iDeal", + "type" : "string" + }, + "pspReference" : { + "description" : "Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.", + "type" : "string" + }, + "reason" : { + "description" : "If `success` = `true` and `paymentMethod` = `visa`, `mc`, or `amex` then this field contains the following details: \nAuhtorisation code, last 4 digits of the card, card expiry date. \n In case of failure, this contains information about the authorisation failure", + "example" : "874574:1935:11/2012", + "type" : "string" + }, + "success" : { + "description" : "If `true`: The payment request was successful. \n If `false`: The payment request failed. \n Check the `reason` field for failure information.", + "type" : "string" + } + }, + "required" : [ + "pspReference", + "merchantReference", + "merchantAccountCode", + "eventDate", + "eventCode", + "amount", + "paymentMethod", + "success", + "operations" + ] + }, + "NotificationAdditionalData" : { + "properties" : { + "authCode" : { + "description" : "When the payment is authorised successfully, this fields holds the authorisation code for the payment, otherwise it's empty.", + "type" : "string" + }, + "authorisedAmountCurrency" : { + "description" : "Currency of the authorised amount.", + "type" : "string" + }, + "authorisedAmountValue" : { + "description" : "Value of the amount authorised. : a bunch more information", + "type" : "string" + }, + "cardSummary" : { + "description" : "Returns the last 4 digits of the credit card.", + "type" : "string" + }, + "expiryDate" : { + "description" : "Returns the card expiry date.", + "type" : "string" + } + } + }, + "NotificationRequest" : { + "properties" : { + "live" : { + "description" : "Informs about the origin of the notification. The value is `true` when originating from the live environment, `false` for the test environment.", + "type" : "boolean" + }, + "notificationItems" : { + "description" : "A container object for the details included in the notification.", + "items" : { + "$ref" : "#/components/schemas/NotificationRequestItem" + }, + "type" : "array" + } + } + }, + "NotificationRequestItem" : { + "properties" : { + "additionalData" : { + "description" : "This object is a generic container that can hold extra fields.", + "$ref" : "#/components/schemas/NotificationAdditionalData" + }, + "amount" : { + "description" : "A container object vor the payable amount information for the transaction. For HTTP POST notifications, currency and value are returned as URL parameters.", + "$ref" : "#/components/schemas/Amount" + }, + "eventCode" : { + "description" : "The type of event the notification item refers to. : This equals the name of the 'endpoint'.", + "type" : "string" + }, + "eventDate" : { + "description" : "The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD", + "example" : "2021-07-17T13:42:40+01:00", + "format" : "date-time", + "type" : "string" + }, + "merchantAccountCode" : { + "description" : "The merchant account identifier used in the transaction the notification item refers to.", + "type" : "string" + }, + "merchantReference" : { + "description" : "A reference to uniquely identify the payment. ", + "type" : "string" + }, + "paymentMethod" : { + "description" : "The payment method used in the transaction.", + "example" : "visa, mc, iDeal", + "type" : "string" + }, + "pspReference" : { + "description" : "Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.", + "type" : "string" + }, + "reason" : { + "description" : "If `success` = `false`, then this includes a short message with an explanation for the refusal.", + "type" : "string" + }, + "success" : { + "description" : "Informs about the outcome of the event (`eventCode`) the notification refers to. \nIf `true`: the event the notification refers to was executed successfully. \nIf `false`: the event was not executed successfully.", + "type" : "boolean" + } + }, + "required" : [ + "pspReference", + "merchantReference", + "merchantAccountCode", + "eventDate", + "eventCode", + "amount", + "success", + "paymentMethod" + ] + }, + "NotificationResponse" : { + "properties" : { + "notificationResponse" : { + "description" : "Set this parameter to **[accepted]** to acknowledge that you received a notification from Adyen.", + "type" : "string" + } + } + }, + "PaidoutReversedNotificationRequest" : { + "properties" : { + "live" : { + "description" : "Informs about the origin of the notification. The value is `true` when originating from the live environment, `false` for the test environment.", + "type" : "boolean" + }, + "notificationItems" : { + "description" : "A container object for the details included in the notification.", + "items" : { + "$ref" : "#/components/schemas/PaidoutReversedNotificationRequestItem" + }, + "type" : "array" + } + } + }, + "PaidoutReversedNotificationRequestItem" : { + "properties" : { + "additionalData" : { + "description" : "This object is a generic container that can hold extra fields.", + "$ref" : "#/components/schemas/NotificationAdditionalData" + }, + "amount" : { + "description" : "A container object vor the payable amount information for the transaction. For HTTP POST notifications, currency and value are returned as URL parameters.", + "$ref" : "#/components/schemas/Amount" + }, + "eventCode" : { + "description" : "The type of event the notification item refers to. : This equals the name of the 'endpoint'.", + "type" : "string" + }, + "eventDate" : { + "description" : "The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD", + "example" : "2021-07-17T13:42:40+01:00", + "format" : "date-time", + "type" : "string" + }, + "merchantAccountCode" : { + "description" : "The merchant account identifier used in the transaction the notification item refers to.", + "type" : "string" + }, + "merchantReference" : { + "description" : "A reference to uniquely identify the payment. ", + "type" : "string" + }, + "paymentMethod" : { + "description" : "The payment method used in the transaction.", + "example" : "visa, mc, iDeal", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference for the Capture's PSP reference.", + "type" : "string" + }, + "reason" : { + "description" : "Contains the bank statement description if present, else it contains `PaidOutReversed`.", + "type" : "string" + }, + "success" : { + "description" : "Informs about the outcome of the event (`eventCode`) the notification refers to. \nIf `true`: the event the notification refers to was executed successfully. \nIf `false`: the event was not executed successfully.", + "type" : "boolean" + } + }, + "required" : [ + "merchantReference", + "merchantAccountCode", + "eventDate", + "eventCode", + "amount", + "success", + "paymentMethod", + "pspReference" + ] + }, + "RecurringContractNoficationRequestItem" : { + "properties" : { + "additionalData" : { + "description" : "This object is a generic container that can hold extra fields.", + "$ref" : "#/components/schemas/RecurringContractNotificationAdditionalData" + }, + "amount" : { + "description" : "A container object vor the payable amount information for the transaction. For HTTP POST notifications, currency and value are returned as URL parameters.", + "$ref" : "#/components/schemas/Amount" + }, + "eventCode" : { + "description" : "The type of event the notification item refers to. : This equals the name of the 'endpoint'.", + "type" : "string" + }, + "eventDate" : { + "description" : "The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD", + "example" : "2021-07-17T13:42:40+01:00", + "format" : "date-time", + "type" : "string" + }, + "merchantAccountCode" : { + "description" : "The merchant account identifier used in the transaction the notification item refers to.", + "type" : "string" + }, + "merchantReference" : { + "description" : "A reference to uniquely identify the payment. ", + "type" : "string" + }, + "paymentMethod" : { + "description" : "The payment method used in the transaction.", + "example" : "visa, mc, iDeal", + "type" : "string" + }, + "pspReference" : { + "description" : "Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.", + "type" : "string" + }, + "reason" : { + "description" : "If `success` = `false`, then this includes a short message with an explanation for the refusal.", + "type" : "string" + }, + "success" : { + "description" : "Informs about the outcome of the event (`eventCode`) the notification refers to. \nIf `true`: the event the notification refers to was executed successfully. \nIf `false`: the event was not executed successfully.", + "type" : "boolean" + } + }, + "required" : [ + "pspReference", + "merchantReference", + "merchantAccountCode", + "eventDate", + "eventCode", + "amount", + "success", + "paymentMethod" + ] + }, + "RecurringContractNotificationAdditionalData" : { + "properties" : { + "authCode" : { + "description" : "When the payment is authorised successfully, this fields holds the authorisation code for the payment, otherwise it's empty.", + "type" : "string" + }, + "authorisedAmountCurrency" : { + "description" : "Currency of the authorised amount.", + "type" : "string" + }, + "authorisedAmountValue" : { + "description" : "Value of the amount authorised. : a bunch more information", + "type" : "string" + }, + "cardSummary" : { + "description" : "Returns the last 4 digits of the credit card.", + "type" : "string" + }, + "expiryDate" : { + "description" : "Returns the card expiry date.", + "type" : "string" + }, + "shopperEmail" : { + "description" : "The shopper's email address.", + "type" : "string" + }, + "shopperReference" : { + "description" : "The ID that uniquely identifies the shopper. The `shopperReference` is the same as the `shopperReference` used in the initial payment.", + "type" : "string" + } + } + }, + "RecurringContractNotificationRequest" : { + "properties" : { + "live" : { + "description" : "Informs about the origin of the notification. The value is `true` when originating from the live environment, `false` for the test environment.", + "type" : "boolean" + }, + "notificationItems" : { + "description" : "A container object for the details included in the notification.", + "items" : { + "$ref" : "#/components/schemas/RecurringContractNoficationRequestItem" + }, + "type" : "array" + } + } + }, + "ReportAvailableNotificationRequest" : { + "properties" : { + "live" : { + "description" : "Informs about the origin of the notification. The value is `true` when originating from the live environment, `false` for the test environment.", + "type" : "boolean" + }, + "notificationItems" : { + "description" : "A container object for the details included in the notification.", + "items" : { + "$ref" : "#/components/schemas/ReportAvailableNotificationRequestItem" + }, + "type" : "array" + } + } + }, + "ReportAvailableNotificationRequestItem" : { + "properties" : { + "additionalData" : { + "description" : "This object is a generic container that can hold extra fields.", + "$ref" : "#/components/schemas/NotificationAdditionalData" + }, + "amount" : { + "description" : "A container object vor the payable amount information for the transaction. For HTTP POST notifications, currency and value are returned as URL parameters.", + "$ref" : "#/components/schemas/Amount" + }, + "eventCode" : { + "description" : "The type of event the notification item refers to. : This equals the name of the 'endpoint'.", + "type" : "string" + }, + "eventDate" : { + "description" : "The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD", + "example" : "2021-07-17T13:42:40+01:00", + "format" : "date-time", + "type" : "string" + }, + "merchantAccountCode" : { + "description" : "The merchant account identifier used in the transaction the notification item refers to.", + "type" : "string" + }, + "merchantReference" : { + "description" : "A reference to uniquely identify the payment. ", + "type" : "string" + }, + "paymentMethod" : { + "description" : "The payment method used in the transaction.", + "example" : "visa, mc, iDeal", + "type" : "string" + }, + "pspReference" : { + "description" : "Contains the file name of the report.", + "type" : "string" + }, + "reason" : { + "description" : "Contains the download URL where you can obtain a copy of the report.", + "type" : "string" + }, + "success" : { + "description" : "Always `true`.", + "type" : "string" + } + }, + "required" : [ + "merchantReference", + "merchantAccountCode", + "eventDate", + "eventCode", + "amount", + "paymentMethod", + "reason", + "success", + "pspReference" + ] + } + }, + "securitySchemes" : { + "ApiKeyAuth" : { + "in" : "header", + "name" : "X-API-Key", + "type" : "apiKey" + }, + "BasicAuth" : { + "scheme" : "basic", + "type" : "http" + } + }, + "examples" : { + "WebhookAck" : { + "summary" : "Acknowledge Webhook", + "value" : { + "notificationResponse" : "[accepted]" + } + }, + "post-AUTHORISATION-authorisation" : { + "summary" : "AUTHORISATION example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "recurring.recurringDetailReference" : "9915692881181044", + "recurring.shopperReference" : "YOUR_SHOPPER_REFERENCE" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "AUTHORISATION", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "ach", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "null", + "success" : "true" + } + } + ] + } + }, + "post-AUTHORISATION_ADJUSTMENT-authorisation_adjustment" : { + "summary" : "AUTHORISATION_ADJUSTMENT example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "AUTHORISATION_ADJUSTMENT", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-AUTORESCUE-autorescue" : { + "summary" : "AUTORESCUE example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "retry.rescueReference" : "8826173525728789", + "merchantOrderReference" : "8826173525728789", + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7..." + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "AUTORESCUE", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-CANCELLATION-cancellation" : { + "summary" : "CANCELLATION example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CANCELLATION", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-CANCEL_AUTORESCUE-cancel_autorescue" : { + "summary" : "CANCEL_AUTORESCUE example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7..." + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CANCEL_AUTORESCUE", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "No AutoRescue process for retry.rescueReference 8826173525728789", + "success" : "false" + } + } + ] + } + }, + "post-CANCEL_OR_REFUND-cancel_or_refund" : { + "summary" : "CANCEL_OR_REFUND example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "modification.action" : "cancel" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CANCEL_OR_REFUND", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-CAPTURE-capture" : { + "summary" : "CAPTURE example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CAPTURE", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-CAPTURE_FAILED-capture_failed" : { + "summary" : "CAPTURE_FAILED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "paymentMethodVariant" : "facilypay_3x", + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "shopperCountry" : "NL" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CAPTURE_FAILED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "facilypay_3x", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Capture Failed", + "success" : "true" + } + } + ] + } + }, + "post-CHARGEBACK-chargeback" : { + "summary" : "CHARGEBACK example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "captureMerchantReference" : "shopperReferenceTest", + "chargebackReasonCode" : " 4853", + "InvoiceCreditorAccount" : "Creditor.AdyenInvoiceService", + "grossCurrency" : "EUR", + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "defensePeriodEndsAt" : "2021-07-31T03:03:07+02:00", + "defendable" : "true", + "grossValue" : "2000", + "modificationMerchantReferences" : "shopperReferenceTest", + "chargebackSchemeCode" : "mc", + "capturePspReference" : "8636172945333378", + "paymentMethodVariant" : "mc", + "shopperReference" : "123456" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CHARGEBACK", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Payment.TxId=300000000524534724 dispute", + "success" : "true" + } + } + ] + } + }, + "post-CHARGEBACK_REVERSED-chargeback_reversed" : { + "summary" : "CHARGEBACK_REVERSED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7..." + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "CHARGEBACK_REVERSED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Fraudulent Processing of Transactions", + "success" : "true" + } + } + ] + } + }, + "post-MANUAL_REVIEW_ACCEPT-manual_review_accept" : { + "summary" : "MANUAL_REVIEW_ACCEPT example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "paymentMethodVariant" : "scheme" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "MANUAL_REVIEW_ACCEPT", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "expire", + "success" : "true" + } + } + ] + } + }, + "post-MANUAL_REVIEW_REJECT-manual_review_reject" : { + "summary" : "MANUAL_REVIEW_REJECT example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "paymentMethodVariant" : "visa" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "MANUAL_REVIEW_REJECT", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "expire", + "success" : "true" + } + } + ] + } + }, + "post-NOTIFICATION_OF_CHARGEBACK-notification_of_chargeback" : { + "summary" : "NOTIFICATION_OF_CHARGEBACK example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "captureMerchantReference" : "shopperReferenceTest", + "chargebackReasonCode" : " 4853", + "grossCurrency" : "EUR", + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "defensePeriodEndsAt" : "2021-07-31T03:03:08+02:00", + "defendable" : "false", + "grossValue" : "2000", + "modificationMerchantReferences" : "YourModificationReference,shopperReferenceTest", + "chargebackSchemeCode" : "mc", + "capturePspReference" : "8536173024791891", + "autoDefended" : "true", + "paymentMethodVariant" : "mc" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "NOTIFICATION_OF_CHARGEBACK", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Payment.TxId=300000000524659113 dispute (automatically defended)", + "success" : "true" + } + } + ] + } + }, + "post-NOTIFICATION_OF_FRAUD-notification_of_fraud" : { + "summary" : "NOTIFICATION_OF_FRAUD example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "nofReasonCode" : "6", + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "modificationMerchantReferences" : "shopperReferenceTest", + "nofSchemeCode" : "visa" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "NOTIFICATION_OF_FRAUD", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Fraudulent Use of Account Number", + "success" : "true" + } + } + ] + } + }, + "post-OFFER_CLOSED-offer_closed" : { + "summary" : "OFFER_CLOSED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "paymentMethodVariant" : "ideal" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "OFFER_CLOSED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "ideal", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-ORDER_CLOSED-order_closed" : { + "summary" : "ORDER_CLOSED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "order-1-pspReference" : "861617275047284E", + "order-1-paymentAmount" : "EUR 10.00", + "order-1-success" : "true", + "order-1-paymentMethod" : "ideal" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "ORDER_CLOSED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "false" + } + } + ] + } + }, + "post-ORDER_OPENED-order_opened" : { + "summary" : "ORDER_OPENED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "ORDER_OPENED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-PAIDOUT_REVERSED-paidout_reversed" : { + "summary" : "PAIDOUT_REVERSED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "PAIDOUT_REVERSED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-PAYOUT_DECLINE-payout_decline" : { + "summary" : "PAYOUT_DECLINE example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "paymentMethodVariant" : "bankTransfer_IBAN" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "PAYOUT_DECLINE", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "bankTransfer_IBAN", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-PAYOUT_EXPIRE-payout_expire" : { + "summary" : "PAYOUT_EXPIRE example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "PAYOUT_EXPIRE", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "bankTransfer_IBAN", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-PAYOUT_THIRDPARTY-payout_thirdparty" : { + "summary" : "PAYOUT_THIRDPARTY example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "expiryDate" : "03/2030", + "paymentMethodVariant" : "visa", + "cardSummary" : "1111", + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7..." + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "PAYOUT_THIRDPARTY", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Approved", + "success" : "true" + } + } + ] + } + }, + "post-POSTPONED_REFUND-postponed_refund" : { + "summary" : "POSTPONED_REFUND example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7..." + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "POSTPONED_REFUND", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "directdebit_NL", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-PREARBITRATION_LOST-prearbitration_lost" : { + "summary" : "PREARBITRATION_LOST example", + "value" : { + "live" : "true", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "metadata.type" : "web_pay", + "metadata.link_id" : "111111", + "arn" : "ACQUIRER_REFERENCE_NUMBER", + "metadata.company" : "abc" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "PREARBITRATION_LOST", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Other Fraud-Card Absent Environment", + "success" : "true" + } + } + ] + } + }, + "post-PREARBITRATION_WON-prearbitration_won" : { + "summary" : "PREARBITRATION_WON example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "PREARBITRATION_WON", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "bankTransfer_IBAN", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-RECURRING_CONTRACT-recurring_contract" : { + "summary" : "RECURRING_CONTRACT example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "shopperEmail" : "s.hopper@adyen.com", + "paymentMethodVariant" : "ideal", + "paymentLinkId" : "PL50C5F751CED39G71", + "shopperReference" : "YOU_SHOPPER_REFERENCE" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "RECURRING_CONTRACT", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "ideal", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-REFUND-refund" : { + "summary" : "REFUND example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "REFUND", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "visa", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Transaction hasn't been captured, refund not possible", + "success" : "false" + } + } + ] + } + }, + "post-REFUND_FAILED-refund_failed" : { + "summary" : "REFUND_FAILED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "paymentMethodVariant" : "blik" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "REFUND_FAILED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "blik", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "Refund Failed", + "success" : "true" + } + } + ] + } + }, + "post-REFUND_REVERSED-refund_reversed" : { + "summary" : "REFUNDED_REVERSED example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "REFUNDED_REVERSED", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "test_AUTHORISATION_1", + "success" : "true" + } + } + ] + } + }, + "post-REFUND_WITH_DATA-refund_with_data" : { + "summary" : "REFUND_WITH_DATA example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "REFUND_WITH_DATA", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MODIFICATION_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-REPORT_AVAILABLE-report_available" : { + "summary" : "REPORT_AVAILABLE example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7..." + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "REPORT_AVAILABLE", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "URL_TO_DOWNLOAD_REPORT", + "success" : "true" + } + } + ] + } + }, + "post-REQUEST_FOR_INFORMATION-request_for_information" : { + "summary" : "REQUEST_FOR_INFORMATION example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "hmacSignature" : "b0ea55c2fe60d4d1d605e9c385e0e7...", + "modificationMerchantReferences" : "9123140123220028" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "REQUEST_FOR_INFORMATION", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-SECOND_CHARGEBACK-second_chargeback" : { + "summary" : "SECOND_CHARGEBACK example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "chargebackReasonCode" : "502", + "modificationMerchantReferences" : "shopperReferenceTest", + "chargebackSchemeCode" : "jcb" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "SECOND_CHARGEBACK", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "paymentMethod" : "jcb", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "502:Cardmember Dispute", + "success" : "true" + } + } + ] + } + }, + "post-TECHNICAL_CANCEL-technical_cancel" : { + "summary" : "TECHNICAL_CANCEL example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "paymentMethodVariant" : "visa" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "TECHNICAL_CANCEL", + "eventDate" : "2018-07-18T22:35:14+02:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_ORIGINAL_REFERENCE", + "originalReference" : "8313547924770610", + "paymentMethod" : "visa", + "pspReference" : "8515208516304269", + "reason" : "", + "success" : "true" + } + } + ] + } + }, + "post-VOID_PENDING_REFUND-void_pending_refund" : { + "summary" : "VOID_PENDING_REFUND example", + "value" : { + "live" : "false", + "notificationItems" : [ + { + "NotificationRequestItem" : { + "additionalData" : { + "paymentMethodVariant" : "mc" + }, + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "eventCode" : "VOID_PENDING_REFUND", + "eventDate" : "2021-01-01T01:00:00+01:00", + "merchantAccountCode" : "YOUR_MERCHANT_ACCOUNT", + "merchantReference" : "YOUR_MERCHANT_REFERENCE", + "originalReference" : "9913140798220028", + "paymentMethod" : "mc", + "pspReference" : "YOUR_PSP_REFERENCE", + "reason" : "", + "success" : "true" + } + } + ] + } + } + } + } +} \ No newline at end of file