diff --git a/json/AccountService-v3.json b/json/AccountService-v3.json index ec1ba3a..e454bd8 100644 --- a/json/AccountService-v3.json +++ b/json/AccountService-v3.json @@ -25,8 +25,8 @@ "paths" : { "/closeAccount" : { "post" : { - "summary" : "Close an existing account under an account holder.", - "description" : "This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Accounts", "x-sortIndex" : 3, @@ -120,8 +120,8 @@ }, "/closeAccountHolder" : { "post" : { - "summary" : "Close an existing account holder.", - "description" : "This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -215,8 +215,8 @@ }, "/createAccount" : { "post" : { - "summary" : "Create a new account under an existing account holder.", - "description" : "This endpoint is used to create an account under an existing account holder. An account holder may have multiple 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", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -311,7 +311,7 @@ "/createAccountHolder" : { "post" : { "summary" : "Create a new account holder.", - "description" : "This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -434,8 +434,8 @@ }, "/deleteBankAccounts" : { "post" : { - "summary" : "Delete bank accounts of an existing account holder.", - "description" : "This endpoint is used to delete existing bank accounts from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete.", + "summary" : "Delete bank accounts of an account holder.", + "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", "x-groupName" : "Verification", "x-sortIndex" : 3, @@ -530,7 +530,7 @@ "/deleteShareholders" : { "post" : { "summary" : "Delete shareholders of an existing account holder.", - "description" : "This endpoint is used to delete existing shareholders from an account holder.", + "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", "x-sortIndex" : 4, @@ -625,7 +625,7 @@ "/getAccountHolder" : { "post" : { "summary" : "Retrieve the details of an account holder.", - "description" : "This endpoint is used to retrieve the details of an account holder.", + "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 2, @@ -723,13 +723,18 @@ "/getTaxForm" : { "post" : { "summary" : "Request a tax form for an account holder.", - "description" : "This endpoint allows to generate a tax form for an account holder.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 8, "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-getTaxForm-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/GetTaxFormRequest" } @@ -813,7 +818,7 @@ "/getUploadedDocuments" : { "post" : { "summary" : "Retrieve the uploaded documents of an existing account holder.", - "description" : "This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "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", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -907,8 +912,8 @@ }, "/suspendAccountHolder" : { "post" : { - "summary" : "Suspend an existing account holder.", - "description" : "This endpoint is used to suspend an existing account holder. If an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1002,8 +1007,8 @@ }, "/unSuspendAccountHolder" : { "post" : { - "summary" : "Reinstate a disabled account holder.", - "description" : "This endpoint is used to reinstate an existing account holder that has been suspended either through the `/suspendAccountHolder` endpoint or because a KYC deadline expired.\n\nHowever, an account holder that has been suspended by Adyen because of KYC verification issues (indicated by a **FAILED** verification [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)) cannot be reinstated through this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -1097,8 +1102,8 @@ }, "/updateAccount" : { "post" : { - "summary" : "Update an existing account under an account holder.", - "description" : "This endpoint is used to update the description or payout schedule of an existing account.", + "summary" : "Update an account.", + "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", "x-groupName" : "Accounts", "x-sortIndex" : 2, @@ -1192,8 +1197,8 @@ }, "/updateAccountHolder" : { "post" : { - "summary" : "Update an existing account holder.", - "description" : "This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder.\n\nIf updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:\n* `accountHolderDetails.address`\n* `accountHolderDetails.fullPhoneNumber`\n* `accountHolderDetails.bankAccountDetails.BankAccountDetail`\n* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).\n\nNote that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`.\n\nSimilarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`.\n> The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 3, @@ -1296,8 +1301,8 @@ }, "/updateAccountHolderState" : { "post" : { - "summary" : "Update the state of an existing account holder.", - "description" : "This endpoint is used to disable or enable the processing or payout state of an account holder.\n\nFor more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/platforms).", + "summary" : "Update the payout or processing state of an account holder.", + "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", "x-groupName" : "Account holders", "x-sortIndex" : 4, @@ -1391,8 +1396,8 @@ }, "/uploadDocument" : { "post" : { - "summary" : "Upload a document for an existing account holder.", - "description" : "This endpoint is used to upload a document for use in the KYC verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "summary" : "Upload a document for an account holder.", + "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", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -1998,6 +2003,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -2680,6 +2686,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3043,6 +3050,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3274,7 +3282,8 @@ } ] }, - "email" : "test@adyen.com" + "email" : "test@adyen.com", + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Business" } @@ -3402,7 +3411,8 @@ "gender" : "MALE", "lastName" : "Green" } - } + }, + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Individual" } @@ -3530,6 +3540,14 @@ "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" } }, + "post-getTaxForm-basic" : { + "summary" : "Get a tax form", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "formType" : "1099-K", + "year" : 2020 + } + }, "post-getUploadedDocuments-basic" : { "summary" : "Get uploaded documents", "value" : { diff --git a/json/AccountService-v4.json b/json/AccountService-v4.json index 2e912f9..b4ec273 100644 --- a/json/AccountService-v4.json +++ b/json/AccountService-v4.json @@ -25,8 +25,8 @@ "paths" : { "/closeAccount" : { "post" : { - "summary" : "Close an existing account under an account holder.", - "description" : "This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Accounts", "x-sortIndex" : 3, @@ -120,8 +120,8 @@ }, "/closeAccountHolder" : { "post" : { - "summary" : "Close an existing account holder.", - "description" : "This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -215,8 +215,8 @@ }, "/createAccount" : { "post" : { - "summary" : "Create a new account under an existing account holder.", - "description" : "This endpoint is used to create an account under an existing account holder. An account holder may have multiple 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", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -311,7 +311,7 @@ "/createAccountHolder" : { "post" : { "summary" : "Create a new account holder.", - "description" : "This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -408,8 +408,8 @@ }, "/deleteBankAccounts" : { "post" : { - "summary" : "Delete bank accounts of an existing account holder.", - "description" : "This endpoint is used to delete existing bank accounts from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete.", + "summary" : "Delete bank accounts of an account holder.", + "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", "x-groupName" : "Verification", "x-sortIndex" : 3, @@ -504,7 +504,7 @@ "/deleteShareholders" : { "post" : { "summary" : "Delete shareholders of an existing account holder.", - "description" : "This endpoint is used to delete existing shareholders from an account holder.", + "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", "x-sortIndex" : 4, @@ -599,7 +599,7 @@ "/getAccountHolder" : { "post" : { "summary" : "Retrieve the details of an account holder.", - "description" : "This endpoint is used to retrieve the details of an account holder.", + "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 2, @@ -697,13 +697,18 @@ "/getTaxForm" : { "post" : { "summary" : "Request a tax form for an account holder.", - "description" : "This endpoint allows to generate a tax form for an account holder.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 8, "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-getTaxForm-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/GetTaxFormRequest" } @@ -787,7 +792,7 @@ "/getUploadedDocuments" : { "post" : { "summary" : "Retrieve the uploaded documents of an existing account holder.", - "description" : "This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "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", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -881,8 +886,8 @@ }, "/suspendAccountHolder" : { "post" : { - "summary" : "Suspend an existing account holder.", - "description" : "This endpoint is used to suspend an existing account holder. If an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -976,8 +981,8 @@ }, "/unSuspendAccountHolder" : { "post" : { - "summary" : "Reinstate a disabled account holder.", - "description" : "This endpoint is used to reinstate an existing account holder that has been suspended either through the `/suspendAccountHolder` endpoint or because a KYC deadline expired.\n\nHowever, an account holder that has been suspended by Adyen because of KYC verification issues (indicated by a **FAILED** verification [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)) cannot be reinstated through this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -1071,8 +1076,8 @@ }, "/updateAccount" : { "post" : { - "summary" : "Update an existing account under an account holder.", - "description" : "This endpoint is used to update the description or payout schedule of an existing account.", + "summary" : "Update an account.", + "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", "x-groupName" : "Accounts", "x-sortIndex" : 2, @@ -1166,8 +1171,8 @@ }, "/updateAccountHolder" : { "post" : { - "summary" : "Update an existing account holder.", - "description" : "This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder.\n\nIf updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:\n* `accountHolderDetails.address`\n* `accountHolderDetails.fullPhoneNumber`\n* `accountHolderDetails.bankAccountDetails.BankAccountDetail`\n* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).\n\nNote that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`.\n\nSimilarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`.\n> The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 3, @@ -1270,8 +1275,8 @@ }, "/updateAccountHolderState" : { "post" : { - "summary" : "Update the state of an existing account holder.", - "description" : "This endpoint is used to disable or enable the processing or payout state of an account holder.\n\nFor more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/platforms).", + "summary" : "Update the payout or processing state of an account holder.", + "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", "x-groupName" : "Account holders", "x-sortIndex" : 4, @@ -1365,8 +1370,8 @@ }, "/uploadDocument" : { "post" : { - "summary" : "Upload a document for an existing account holder.", - "description" : "This endpoint is used to upload a document for use in the KYC verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "summary" : "Upload a document for an account holder.", + "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", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2020,6 +2025,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -2722,6 +2728,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3122,6 +3129,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3357,7 +3365,8 @@ } ] }, - "email" : "test@adyen.com" + "email" : "test@adyen.com", + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Business" } @@ -3377,7 +3386,8 @@ }, "address" : { "country" : "US" - } + }, + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Individual" } @@ -3412,6 +3422,14 @@ "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" } }, + "post-getTaxForm-basic" : { + "summary" : "Get a tax form", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "formType" : "1099-K", + "year" : 2020 + } + }, "post-getUploadedDocuments-basic" : { "summary" : "Get uploaded documents", "value" : { diff --git a/json/AccountService-v5.json b/json/AccountService-v5.json index 4bf3abf..8941c89 100644 --- a/json/AccountService-v5.json +++ b/json/AccountService-v5.json @@ -25,8 +25,8 @@ "paths" : { "/checkAccountHolder" : { "post" : { - "summary" : "Request to perform verification for an account holder.", - "description" : "This endpoint allows to trigger the verification of the account holder earlier than it's required by the currently processed volume.", + "summary" : "Perform verification for an account holder.", + "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, "operationId" : "post-checkAccountHolder", "x-groupName" : "Verification", @@ -121,8 +121,8 @@ }, "/closeAccount" : { "post" : { - "summary" : "Close an existing account under an account holder.", - "description" : "This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Accounts", "x-sortIndex" : 3, @@ -216,8 +216,8 @@ }, "/closeAccountHolder" : { "post" : { - "summary" : "Close an existing account holder.", - "description" : "This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -311,8 +311,8 @@ }, "/createAccount" : { "post" : { - "summary" : "Create a new account under an existing account holder.", - "description" : "This endpoint is used to create an account under an existing account holder. An account holder may have multiple 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", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -407,7 +407,7 @@ "/createAccountHolder" : { "post" : { "summary" : "Create a new account holder.", - "description" : "This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -504,8 +504,8 @@ }, "/deleteBankAccounts" : { "post" : { - "summary" : "Delete bank accounts of an existing account holder.", - "description" : "This endpoint is used to delete existing bank accounts from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete.", + "summary" : "Delete bank accounts of an account holder.", + "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", "x-groupName" : "Verification", "x-sortIndex" : 3, @@ -599,8 +599,8 @@ }, "/deletePayoutMethods" : { "post" : { - "summary" : "Delete payout methods of an existing account holder.", - "description" : "This endpoint is used to delete existing payout method from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `payoutMethodCodes` specifying payout methods to delete.", + "summary" : "Delete payout methods of an account holder.", + "description" : "Deletes one or more payout methods of an account holder.", "x-addedInVersion" : 5, "operationId" : "post-deletePayoutMethods", "x-groupName" : "Verification", @@ -696,7 +696,7 @@ "/deleteShareholders" : { "post" : { "summary" : "Delete shareholders of an existing account holder.", - "description" : "This endpoint is used to delete existing shareholders from an account holder.", + "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", "x-sortIndex" : 4, @@ -791,7 +791,7 @@ "/getAccountHolder" : { "post" : { "summary" : "Retrieve the details of an account holder.", - "description" : "This endpoint is used to retrieve the details of an account holder.", + "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 2, @@ -889,13 +889,18 @@ "/getTaxForm" : { "post" : { "summary" : "Request a tax form for an account holder.", - "description" : "This endpoint allows to generate a tax form for an account holder.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 8, "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-getTaxForm-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/GetTaxFormRequest" } @@ -979,7 +984,7 @@ "/getUploadedDocuments" : { "post" : { "summary" : "Retrieve the uploaded documents of an existing account holder.", - "description" : "This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "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", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -1073,8 +1078,8 @@ }, "/suspendAccountHolder" : { "post" : { - "summary" : "Suspend an existing account holder.", - "description" : "This endpoint is used to suspend an existing account holder. If an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1168,8 +1173,8 @@ }, "/unSuspendAccountHolder" : { "post" : { - "summary" : "Reinstate a disabled account holder.", - "description" : "This endpoint is used to reinstate an existing account holder that has been suspended either through the `/suspendAccountHolder` endpoint or because a KYC deadline expired.\n\nHowever, an account holder that has been suspended by Adyen because of KYC verification issues (indicated by a **FAILED** verification [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)) cannot be reinstated through this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -1263,8 +1268,8 @@ }, "/updateAccount" : { "post" : { - "summary" : "Update an existing account under an account holder.", - "description" : "This endpoint is used to update the description or payout schedule of an existing account.", + "summary" : "Update an account.", + "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", "x-groupName" : "Accounts", "x-sortIndex" : 2, @@ -1358,8 +1363,8 @@ }, "/updateAccountHolder" : { "post" : { - "summary" : "Update an existing account holder.", - "description" : "This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder.\n\nIf updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:\n* `accountHolderDetails.address`\n* `accountHolderDetails.fullPhoneNumber`\n* `accountHolderDetails.bankAccountDetails.BankAccountDetail`\n* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).\n\nNote that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`.\n\nSimilarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`.\n> The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 3, @@ -1462,8 +1467,8 @@ }, "/updateAccountHolderState" : { "post" : { - "summary" : "Update the state of an existing account holder.", - "description" : "This endpoint is used to disable or enable the processing or payout state of an account holder.\n\nFor more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/platforms).", + "summary" : "Update the payout or processing state of an account holder.", + "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", "x-groupName" : "Account holders", "x-sortIndex" : 4, @@ -1557,8 +1562,8 @@ }, "/uploadDocument" : { "post" : { - "summary" : "Upload a document for an existing account holder.", - "description" : "This endpoint is used to upload a document for use in the KYC verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "summary" : "Upload a document for an account holder.", + "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", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2303,6 +2308,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3142,6 +3148,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3730,6 +3737,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3954,7 +3962,8 @@ } ] }, - "email" : "test@email.com" + "email" : "test@email.com", + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Business" } @@ -3974,7 +3983,8 @@ }, "address" : { "country" : "US" - } + }, + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Individual" } @@ -4018,6 +4028,14 @@ "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" } }, + "post-getTaxForm-basic" : { + "summary" : "Get a tax form", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "formType" : "1099-K", + "year" : 2020 + } + }, "post-getUploadedDocuments-basic" : { "summary" : "Get uploaded documents", "value" : { diff --git a/json/AccountService-v6.json b/json/AccountService-v6.json index dac0114..b5d4662 100644 --- a/json/AccountService-v6.json +++ b/json/AccountService-v6.json @@ -25,8 +25,8 @@ "paths" : { "/checkAccountHolder" : { "post" : { - "summary" : "Request to perform verification for an account holder.", - "description" : "This endpoint allows to trigger the verification of the account holder earlier than it's required by the currently processed volume.", + "summary" : "Perform verification for an account holder.", + "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, "operationId" : "post-checkAccountHolder", "x-groupName" : "Verification", @@ -121,8 +121,8 @@ }, "/closeAccount" : { "post" : { - "summary" : "Close an existing account under an account holder.", - "description" : "This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Accounts", "x-sortIndex" : 3, @@ -216,8 +216,8 @@ }, "/closeAccountHolder" : { "post" : { - "summary" : "Close an existing account holder.", - "description" : "This endpoint is used to close an existing account holder and its accounts. If an account holder is closed, it may not process transactions or pay out funds, and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -311,8 +311,8 @@ }, "/createAccount" : { "post" : { - "summary" : "Create a new account under an existing account holder.", - "description" : "This endpoint is used to create an account under an existing account holder. An account holder may have multiple 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", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -407,7 +407,7 @@ "/createAccountHolder" : { "post" : { "summary" : "Create a new account holder.", - "description" : "This endpoint is used to create an account holder. Each account holder represents a single sub-merchant, and each sub-merchant must be represented by an account holder. Depending on the legal entity type, different details are required to be provided in the call to this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -504,8 +504,8 @@ }, "/deleteBankAccounts" : { "post" : { - "summary" : "Delete bank accounts of an existing account holder.", - "description" : "This endpoint is used to delete existing bank accounts from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `bankAccountUUIDs` specifying bank accounts to delete.", + "summary" : "Delete bank accounts of an account holder.", + "description" : "Deletes one or more bank accounts of an account holder. ", "operationId" : "post-deleteBankAccounts", "x-groupName" : "Verification", "x-sortIndex" : 3, @@ -599,8 +599,8 @@ }, "/deletePayoutMethods" : { "post" : { - "summary" : "Delete payout methods of an existing account holder.", - "description" : "This endpoint is used to delete existing payout method from an account holder. For this, pass the `accountHolderCode` you got on the account holder creation, and one or more `payoutMethodCodes` specifying payout methods to delete.", + "summary" : "Delete payout methods of an account holder.", + "description" : "Deletes one or more payout methods of an account holder.", "x-addedInVersion" : 5, "operationId" : "post-deletePayoutMethods", "x-groupName" : "Verification", @@ -696,7 +696,7 @@ "/deleteShareholders" : { "post" : { "summary" : "Delete shareholders of an existing account holder.", - "description" : "This endpoint is used to delete existing shareholders from an account holder.", + "description" : "Deletes one or more shareholders from an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", "x-sortIndex" : 4, @@ -791,7 +791,7 @@ "/getAccountHolder" : { "post" : { "summary" : "Retrieve the details of an account holder.", - "description" : "This endpoint is used to retrieve the details of an account holder.", + "description" : "Retrieves the details of an account holder.", "operationId" : "post-getAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 2, @@ -889,13 +889,18 @@ "/getTaxForm" : { "post" : { "summary" : "Request a tax form for an account holder.", - "description" : "This endpoint allows to generate a tax form for an account holder.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 8, "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-getTaxForm-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/GetTaxFormRequest" } @@ -979,7 +984,7 @@ "/getUploadedDocuments" : { "post" : { "summary" : "Retrieve the uploaded documents of an existing account holder.", - "description" : "This endpoint is used to retrieve documents previously uploaded for use in the KYC Verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "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", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -1073,8 +1078,8 @@ }, "/suspendAccountHolder" : { "post" : { - "summary" : "Suspend an existing account holder.", - "description" : "This endpoint is used to suspend an existing account holder. If an account holder is suspended, it may not process transactions or pay out funds. Any payments made to a suspended account holder will be directed to the merchant's liable account.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1168,8 +1173,8 @@ }, "/unSuspendAccountHolder" : { "post" : { - "summary" : "Reinstate a disabled account holder.", - "description" : "This endpoint is used to reinstate an existing account holder that has been suspended either through the `/suspendAccountHolder` endpoint or because a KYC deadline expired.\n\nHowever, an account holder that has been suspended by Adyen because of KYC verification issues (indicated by a **FAILED** verification [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)) cannot be reinstated through this endpoint.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -1263,8 +1268,8 @@ }, "/updateAccount" : { "post" : { - "summary" : "Update an existing account under an account holder.", - "description" : "This endpoint is used to update the description or payout schedule of an existing account.", + "summary" : "Update an account.", + "description" : "Updates the description or payout schedule of an account.", "operationId" : "post-updateAccount", "x-groupName" : "Accounts", "x-sortIndex" : 2, @@ -1358,8 +1363,8 @@ }, "/updateAccountHolder" : { "post" : { - "summary" : "Update an existing account holder.", - "description" : "This endpoint is used to update the `accountHolderDetails` or `processingTier` of an account holder.\n\nIf updating the `accountHolderDetails`, only the details which have been provided will be updated. Other details will be left as-is with the exception of the following fields:\n* `accountHolderDetails.address`\n* `accountHolderDetails.fullPhoneNumber`\n* `accountHolderDetails.bankAccountDetails.BankAccountDetail`\n* `accountHolderDetails.businessDetails.shareholders.ShareholderContact`, which requires all fields necessary for validation (i.e. in order to update only the `accountHolderDetails.address.postalCode`, the fields `accountHolderDetails.address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` must be provided as well, so that the address can be properly validated).\n\nNote that this endpoint can also be used to create new bank accounts. For this, provide details of a bank account without providing a `bankAccountUUID`.\n\nSimilarly, it can also be used to create new shareholders by providing details of a shareholder without providing a `shareholderCode`.\n> The updating of the `metadata` field will overwite all of the existing account holder metadata. In order to update an existing metadata key-value pair, all otherkey-value pairs should be provided in order to not delete them.", + "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", "x-groupName" : "Account holders", "x-sortIndex" : 3, @@ -1462,8 +1467,8 @@ }, "/updateAccountHolderState" : { "post" : { - "summary" : "Update the state of an existing account holder.", - "description" : "This endpoint is used to disable or enable the processing or payout state of an account holder.\n\nFor more information about processing and payout states of an account holder, refer to [our documentation](https://docs.adyen.com/platforms).", + "summary" : "Update the payout or processing state of an account holder.", + "description" : "Disables or enables the processing or payout state of an account holder.", "operationId" : "post-updateAccountHolderState", "x-groupName" : "Account holders", "x-sortIndex" : 4, @@ -1557,8 +1562,8 @@ }, "/uploadDocument" : { "post" : { - "summary" : "Upload a document for an existing account holder.", - "description" : "This endpoint is used to upload a document for use in the KYC verification of an account holder.\n\nFor further information regarding KYC Verification, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks).", + "summary" : "Upload a document for an account holder.", + "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", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2333,6 +2338,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3155,6 +3161,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3753,6 +3760,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -3977,7 +3985,8 @@ } ] }, - "email" : "test@email.com" + "email" : "test@email.com", + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Business" } @@ -3997,7 +4006,8 @@ }, "address" : { "country" : "US" - } + }, + "webAddress" : "https://www.your-website.com" }, "legalEntity" : "Individual" } @@ -4041,6 +4051,14 @@ "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" } }, + "post-getTaxForm-basic" : { + "summary" : "Get a tax form", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "formType" : "1099-K", + "year" : 2020 + } + }, "post-getUploadedDocuments-basic" : { "summary" : "Get uploaded documents", "value" : { diff --git a/json/BalancePlatformService-v1.json b/json/BalancePlatformService-v1.json index 844aff0..a236f35 100644 --- a/json/BalancePlatformService-v1.json +++ b/json/BalancePlatformService-v1.json @@ -168,6 +168,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-accountHolders-id-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolder" } @@ -178,6 +183,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -188,6 +198,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -198,6 +213,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -208,6 +228,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -218,6 +243,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -396,6 +426,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-accountHolders-id-balanceAccounts-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/PaginatedBalanceAccountsResponse" } @@ -406,6 +441,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -416,6 +456,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -426,6 +471,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -436,6 +486,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -446,6 +501,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -595,6 +655,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-balanceAccounts-id-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/BalanceAccount" } @@ -605,6 +670,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -615,6 +685,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -625,6 +700,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -635,6 +715,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -645,6 +730,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -698,6 +788,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/PaginatedPaymentInstrumentsResponse" } @@ -708,6 +803,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -718,6 +818,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -728,6 +833,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -738,6 +848,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -748,6 +863,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -781,6 +901,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-balancePlatforms-id-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/BalancePlatform" } @@ -791,6 +916,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -801,6 +931,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -811,6 +946,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -821,6 +961,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -831,6 +976,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -884,6 +1034,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-balancePlatforms-id-accountHolders-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/PaginatedAccountHoldersResponse" } @@ -894,6 +1049,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -904,6 +1064,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -914,6 +1079,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -924,6 +1094,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -934,6 +1109,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1189,6 +1369,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1199,6 +1384,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1209,6 +1399,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1219,6 +1414,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1229,6 +1429,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1493,6 +1698,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1503,6 +1713,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1513,6 +1728,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1523,6 +1743,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1533,6 +1758,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -1797,6 +2027,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/PaymentInstrumentGroup" } @@ -1807,6 +2042,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1817,6 +2057,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1827,6 +2072,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1837,6 +2087,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1847,6 +2102,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1880,6 +2140,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/TransactionRulesResponse" } @@ -1890,6 +2155,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1900,6 +2170,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1910,6 +2185,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1920,6 +2200,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -1930,6 +2215,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2082,6 +2372,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-paymentInstruments-id-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/PaymentInstrument" } @@ -2092,6 +2387,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2102,6 +2402,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2112,6 +2417,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2122,6 +2432,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2132,6 +2447,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2296,6 +2616,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/TransactionRulesResponse" } @@ -2306,6 +2631,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2316,6 +2646,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2326,6 +2661,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2336,6 +2676,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2346,6 +2691,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2606,6 +2956,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "success-200" : { + "$ref" : "#/components/examples/get-transactionRules-transactionRuleId-success-200" + } + }, "schema" : { "$ref" : "#/components/schemas/TransactionRuleResponse" } @@ -2616,6 +2971,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2626,6 +2986,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2636,6 +3001,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2646,6 +3016,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -2656,6 +3031,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/RestServiceError" } @@ -3036,6 +3416,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3046,6 +3431,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3056,6 +3446,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3066,6 +3461,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3076,6 +3476,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -3216,6 +3621,7 @@ }, "description" : { "description" : "Your description for the account holder, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "id" : { @@ -3228,6 +3634,7 @@ }, "reference" : { "description" : "Your reference to the account holder, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "status" : { @@ -3269,6 +3676,7 @@ }, "description" : { "description" : "Your description for the account holder, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "legalEntityId" : { @@ -3277,6 +3685,7 @@ }, "reference" : { "description" : "Your reference to the account holder, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "sweepConfigurations" : { @@ -3454,6 +3863,7 @@ }, "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" : { @@ -3469,6 +3879,7 @@ }, "reference" : { "description" : "Your reference to the balance account, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "status" : { @@ -3500,10 +3911,12 @@ }, "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" }, "reference" : { "description" : "Your reference to the balance account, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "sweepConfigurations" : { @@ -3522,6 +3935,7 @@ "properties" : { "description" : { "description" : "A description of the balance platform, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "id" : { @@ -4313,6 +4727,7 @@ }, "description" : { "description" : "Your description for the payment instrument, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "id" : { @@ -4329,6 +4744,7 @@ }, "reference" : { "description" : "Your reference to the payment instrument, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "status" : { @@ -4373,6 +4789,7 @@ }, "description" : { "description" : "Your description for the payment instrument group, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "id" : { @@ -4388,6 +4805,7 @@ }, "reference" : { "description" : "Your reference to the payment instrument group, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "txVariant" : { @@ -4408,6 +4826,7 @@ }, "description" : { "description" : "Your description for the payment instrument group, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "properties" : { @@ -4419,6 +4838,7 @@ }, "reference" : { "description" : "Your reference to the payment instrument group, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "txVariant" : { @@ -4443,6 +4863,7 @@ }, "description" : { "description" : "Your description for the payment instrument, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "issuingCountryCode" : { @@ -4455,6 +4876,7 @@ }, "reference" : { "description" : "Your reference to the payment instrument, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "status" : { @@ -4762,6 +5184,7 @@ }, "description" : { "description" : "Your description for the transaction rule, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "endDate" : { @@ -4833,6 +5256,7 @@ }, "reference" : { "description" : "Your reference for the transaction rule, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "startDate" : { @@ -4884,6 +5308,7 @@ }, "description" : { "description" : "Your description for the transaction rule, maximum 300 characters.", + "maxLength" : 300, "type" : "string" }, "endDate" : { @@ -4951,6 +5376,7 @@ }, "reference" : { "description" : "Your reference for the transaction rule, maximum 150 characters.", + "maxLength" : 150, "type" : "string" }, "startDate" : { @@ -5183,6 +5609,302 @@ "errorCode" : "99_500" } }, + "get-accountHolders-id-balanceAccounts-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a list of balance accounts under an account holder", + "value" : { + "balanceAccounts" : [ + { + "accountHolderId" : "AH32272223222B59K6ZKBBFNQ", + "defaultCurrencyCode" : "EUR", + "id" : "BA32272223222B59K6ZXHBFN6", + "status" : "Active" + }, + { + "accountHolderId" : "AH32272223222B59K6ZKBBFNQ", + "defaultCurrencyCode" : "EUR", + "id" : "BA32272223222B59K72CKBFNJ", + "status" : "Active" + }, + { + "accountHolderId" : "AH32272223222B59K6ZKBBFNQ", + "defaultCurrencyCode" : "EUR", + "id" : "BA32272223222B5BRR27B2M7G", + "status" : "Active" + } + ], + "hasNext" : true, + "hasPrevious" : false + } + }, + "get-accountHolders-id-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving an account holder", + "value" : { + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "contactDetails" : { + "address" : { + "city" : "Amsterdam", + "country" : "NL", + "houseNumberOrName" : "274", + "postalCode" : "1020CD", + "street" : "Brannan Street" + }, + "email" : "s.hopper@example.com", + "phone" : { + "number" : "+315551231234", + "type" : "Mobile" + } + }, + "description" : "S.Hopper - Staff 123", + "id" : "AH32272223222B5CM4MWJ892H", + "status" : "Active" + } + }, + "get-balanceAccounts-id-paymentInstruments-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a list of payment instruments under a balance account", + "value" : { + "hasNext" : "true", + "hasPrevious" : "false", + "paymentInstruments" : [ + { + "balanceAccountId" : "BA32272223222B59CZ3T52DKZ", + "issuingCountryCode" : "GB", + "status" : "Active", + "type" : "card", + "card" : { + "brandVariant" : "mc", + "cardholderName" : "name", + "formFactor" : "virtual", + "bin" : "555544", + "expiration" : { + "month" : "12", + "year" : "2022" + }, + "lastFour" : "2357", + "number" : "************2357" + }, + "id" : "PI32272223222B59M5TM658DT" + }, + { + "balanceAccountId" : "BA32272223222B59CZ3T52DKZ", + "issuingCountryCode" : "GB", + "status" : "Active", + "type" : "card", + "card" : { + "brandVariant" : "mc", + "cardholderName" : "name", + "formFactor" : "virtual", + "bin" : "555544", + "expiration" : { + "month" : "01", + "year" : "2023" + }, + "lastFour" : "8331", + "number" : "************8331" + }, + "id" : "PI32272223222B59PXDGQDLSF" + } + ] + } + }, + "get-balanceAccounts-id-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a balance account", + "value" : { + "accountHolderId" : "AH32272223222B59K6RTQBFNZ", + "defaultCurrencyCode" : "EUR", + "balances" : [ + { + "available" : 0, + "balance" : 0, + "currency" : "EUR", + "reserved" : 0 + } + ], + "id" : "BA3227C223222B5BLP6JQC3FD", + "paymentInstruments" : [ + { + "id" : "PI32272223222B5BRM4FZ7J9J" + } + ], + "status" : "Active" + } + }, + "get-balancePlatforms-id-accountHolders-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a list of account holders under a balance platform", + "value" : { + "accountHolders" : [ + { + "contactDetails" : { + "address" : { + "city" : "Amsterdam", + "country" : "NL", + "houseNumberOrName" : "6", + "postalCode" : "12336750", + "street" : "Simon Carmiggeltstraat" + } + }, + "description" : "J. Doe", + "id" : "AH32272223222B59DDWSCCMP7", + "status" : "Active" + }, + { + "contactDetails" : { + "address" : { + "city" : "Amsterdam", + "country" : "NL", + "houseNumberOrName" : "11", + "postalCode" : "12336750", + "street" : "Simon Carmiggeltstraat" + } + }, + "description" : "S. Hopper", + "id" : "AH32272223222B59DJ7QBCMPN", + "status" : "Active" + } + ], + "hasNext" : "true", + "hasPrevious" : "false" + } + }, + "get-balancePlatforms-id-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a balance platform", + "value" : { + "id" : "YOUR_BALANCE_PLATFORM", + "status" : "Active" + } + }, + "get-paymentInstrumentGroups-id-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a payment instrument group", + "value" : { + "balancePlatform" : "YOUR_BALANCE_PLATFORM", + "txVariant" : "mc", + "id" : "PG3227C223222B5CMD3FJFKGZ" + } + }, + "get-paymentInstrumentGroups-id-transactionRules-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a list of transaction rules applied to a payment instrument group", + "value" : { + "transactionRules" : [ + { + "description" : "Allow 5 transactions per month", + "interval" : { + "type" : "monthly" + }, + "maxTransactions" : 5, + "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", + "reference" : "myRule12345", + "startDate" : "2021-01-25T12:46:35.476629Z", + "status" : "active", + "type" : "velocity", + "id" : "TR32272223222B5CMDGMC9F4F" + }, + { + "amount" : { + "currency" : "EUR", + "value" : 10000 + }, + "description" : "Allow up to 100 EUR per month", + "interval" : { + "type" : "monthly" + }, + "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", + "reference" : "myRule16378", + "startDate" : "2021-01-25T12:46:35.476629Z", + "status" : "active", + "type" : "velocity", + "id" : "TR32272223222B5CMDGT89F4F" + } + ] + } + }, + "get-paymentInstruments-id-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a payment instrument", + "value" : { + "balanceAccountId" : "BA32272223222B59CZ3T52DKZ", + "description" : "S. Hopper - Main card", + "issuingCountryCode" : "GB", + "status" : "Active", + "type" : "card", + "card" : { + "brand" : "mc", + "brandVariant" : "mcdebit", + "cardholderName" : "Simon Hopper", + "formFactor" : "virtual", + "bin" : "555544", + "expiration" : { + "month" : "01", + "year" : "2024" + }, + "lastFour" : "3548", + "number" : "************3548" + }, + "id" : "PI32272223222B5CMD3MQ3HXX" + } + }, + "get-paymentInstruments-id-transactionRules-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a list of transaction rules applied to a payment instrument", + "value" : { + "transactionRules" : [ + { + "description" : "Allow 5 transactions per month", + "interval" : { + "type" : "monthly" + }, + "maxTransactions" : 5, + "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", + "reference" : "myRule12345", + "startDate" : "2021-01-25T12:46:35.476629Z", + "status" : "active", + "type" : "velocity", + "id" : "TR32272223222B5CMDGMC9F4F" + }, + { + "amount" : { + "currency" : "EUR", + "value" : 10000 + }, + "description" : "Allow up to 100 EUR per month", + "interval" : { + "type" : "monthly" + }, + "paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ", + "reference" : "myRule16378", + "startDate" : "2021-01-25T12:46:35.476629Z", + "status" : "active", + "type" : "velocity", + "id" : "TR32272223222B5CMDGT89F4F" + } + ] + } + }, + "get-transactionRules-transactionRuleId-success-200" : { + "summary" : "Response code - 200 OK", + "description" : "Example response when retrieving a transaction rule", + "value" : { + "transactionRule" : { + "description" : "Allow 5 transactions per month", + "interval" : { + "type" : "monthly" + }, + "maxTransactions" : 5, + "paymentInstrumentId" : "PI3227C223222B59KGTXP884R", + "reference" : "myRule12345", + "startDate" : "2021-01-25T12:46:35.476629Z", + "status" : "active", + "type" : "velocity", + "id" : "TR32272223222B5CMD3V73HXG" + } + } + }, "patch-accountHolders-id-success-200" : { "summary" : "Response code - 200 OK", "description" : "Example response for successfully updating the status of an account holder", diff --git a/json/BinLookupService-v50.json b/json/BinLookupService-v50.json index 3f19802..cf641d0 100644 --- a/json/BinLookupService-v50.json +++ b/json/BinLookupService-v50.json @@ -460,7 +460,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index 280a25b..b61fa34 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2416,6 +2441,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2682,18 +2708,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2727,7 +2757,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -2859,6 +2889,7 @@ "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" }, "fraudOffset" : { @@ -3053,7 +3084,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3189,7 +3220,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3521,6 +3552,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" } }, @@ -4392,6 +4424,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -4400,6 +4433,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -4428,6 +4462,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -4440,18 +4475,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -4462,7 +4501,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -4507,7 +4546,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "details" : { @@ -5039,6 +5078,7 @@ "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" : { @@ -5280,6 +5320,7 @@ }, "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" : { @@ -5403,7 +5444,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "details" : { @@ -5687,6 +5728,7 @@ }, "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" : { @@ -5801,6 +5843,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -5846,7 +5889,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authResponse" : { @@ -6687,7 +6730,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index c90ae34..1d8986d 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2558,6 +2583,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2870,18 +2896,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2915,7 +2945,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3057,6 +3087,7 @@ "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" }, "fraudOffset" : { @@ -3261,7 +3292,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3397,7 +3428,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3729,6 +3760,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4693,6 +4725,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -4701,6 +4734,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -4729,6 +4763,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -4741,18 +4776,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -4763,7 +4802,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -4808,7 +4847,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -5358,6 +5397,7 @@ "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" : { @@ -5448,6 +5488,7 @@ "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" : { @@ -5609,6 +5650,7 @@ }, "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" : { @@ -5737,7 +5779,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -6034,6 +6076,7 @@ }, "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" : { @@ -6148,6 +6191,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6193,7 +6237,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7060,7 +7104,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index a489532..c03ccec 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2570,6 +2595,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2882,18 +2908,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2927,7 +2957,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3069,6 +3099,7 @@ "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" }, "fraudOffset" : { @@ -3273,7 +3304,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3409,7 +3440,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3741,6 +3772,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4705,6 +4737,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -4713,6 +4746,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -4741,6 +4775,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -4753,18 +4788,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -4775,7 +4814,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -4820,7 +4859,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -5375,6 +5414,7 @@ "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" : { @@ -5465,6 +5505,7 @@ "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" : { @@ -5626,6 +5667,7 @@ }, "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" : { @@ -5754,7 +5796,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -6056,6 +6098,7 @@ }, "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" : { @@ -6170,6 +6213,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6215,7 +6259,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7082,7 +7126,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index f40d9bf..30db2c6 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2570,6 +2595,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2882,18 +2908,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2927,7 +2957,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3069,6 +3099,7 @@ "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" }, "fraudOffset" : { @@ -3273,7 +3304,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3409,7 +3440,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3741,6 +3772,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -4705,6 +4737,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -4713,6 +4746,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -4741,6 +4775,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -4753,18 +4788,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -4775,7 +4814,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -4820,7 +4859,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -5375,6 +5414,7 @@ "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" : { @@ -5465,6 +5505,7 @@ "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" : { @@ -5626,6 +5667,7 @@ }, "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" : { @@ -5754,7 +5796,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -6056,6 +6098,7 @@ }, "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" : { @@ -6170,6 +6213,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6215,7 +6259,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -6928,7 +6972,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7090,7 +7134,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 86af516..35c6306 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2586,6 +2611,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2922,18 +2948,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2975,7 +3005,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3144,6 +3174,7 @@ "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" }, "fraudOffset" : { @@ -3348,7 +3379,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3535,7 +3566,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3795,7 +3826,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4195,6 +4226,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5223,6 +5255,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5231,6 +5264,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5259,6 +5293,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5271,18 +5306,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5293,7 +5332,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5343,7 +5382,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -5924,6 +5963,7 @@ "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" : { @@ -6014,6 +6054,7 @@ "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" : { @@ -6175,6 +6216,7 @@ }, "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" : { @@ -6344,7 +6386,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -6656,6 +6698,7 @@ }, "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" : { @@ -6775,6 +6818,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6820,7 +6864,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7565,7 +7609,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7782,7 +7826,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index 4af101c..ad63e3b 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2935,18 +2961,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2988,7 +3018,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3157,6 +3187,7 @@ "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" }, "fraudOffset" : { @@ -3367,7 +3398,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3554,7 +3585,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3814,7 +3845,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4219,6 +4250,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5247,6 +5279,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5255,6 +5288,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5283,6 +5317,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5295,18 +5330,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5317,7 +5356,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5367,7 +5406,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -5953,6 +5992,7 @@ "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" : { @@ -6043,6 +6083,7 @@ "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" : { @@ -6204,6 +6245,7 @@ }, "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" : { @@ -6379,7 +6421,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -6691,6 +6733,7 @@ }, "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" : { @@ -6816,6 +6859,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6861,7 +6905,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7606,7 +7650,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7823,7 +7867,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index 4d2d09e..457b8af 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2935,18 +2961,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2988,7 +3018,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3157,6 +3187,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3373,7 +3404,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3560,7 +3591,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3820,7 +3851,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4225,6 +4256,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5253,6 +5285,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5261,6 +5294,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5289,6 +5323,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5301,18 +5336,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5323,7 +5362,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5373,7 +5412,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -5972,6 +6011,7 @@ "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" : { @@ -6068,6 +6108,7 @@ "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" : { @@ -6229,6 +6270,7 @@ }, "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" : { @@ -6404,7 +6446,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authentication" : { @@ -6722,6 +6764,7 @@ }, "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" : { @@ -6847,6 +6890,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6892,7 +6936,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7637,7 +7681,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7854,7 +7898,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index 1cc7a04..f546eb5 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2935,18 +2961,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2988,7 +3018,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3157,6 +3187,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3373,7 +3404,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3560,7 +3591,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3820,7 +3851,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4225,6 +4256,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5253,6 +5285,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5261,6 +5294,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5289,6 +5323,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5301,18 +5336,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5323,7 +5362,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5373,7 +5412,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -5977,6 +6016,7 @@ "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" : { @@ -6073,6 +6113,7 @@ "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" : { @@ -6234,6 +6275,7 @@ }, "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" : { @@ -6409,7 +6451,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6732,6 +6774,7 @@ }, "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" : { @@ -6857,6 +6900,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6902,7 +6946,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7647,7 +7691,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7864,7 +7908,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index ab4cef7..cd21bfc 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2935,18 +2961,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2988,7 +3018,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3157,6 +3187,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3373,7 +3404,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3560,7 +3591,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3820,7 +3851,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4225,6 +4256,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5253,6 +5285,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5261,6 +5294,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5289,6 +5323,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5301,18 +5336,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5323,7 +5362,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5373,7 +5412,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -5991,6 +6030,7 @@ "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" : { @@ -6087,6 +6127,7 @@ "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" : { @@ -6248,6 +6289,7 @@ }, "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" : { @@ -6423,7 +6465,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6746,6 +6788,7 @@ }, "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" : { @@ -6871,6 +6914,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6916,7 +6960,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7669,7 +7713,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7886,7 +7930,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index c6c3cdb..6c7bf7f 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2935,18 +2961,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2988,7 +3018,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3157,6 +3187,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3373,7 +3404,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3560,7 +3591,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3820,7 +3851,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4225,6 +4256,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5289,6 +5321,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5297,6 +5330,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5325,6 +5359,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5337,18 +5372,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5359,7 +5398,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5409,7 +5448,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6046,6 +6085,7 @@ "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" : { @@ -6142,6 +6182,7 @@ "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" : { @@ -6303,6 +6344,7 @@ }, "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" : { @@ -6478,7 +6520,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6815,6 +6857,7 @@ }, "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" : { @@ -6940,6 +6983,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6985,7 +7029,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7738,7 +7782,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7955,7 +7999,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index d6d7d64..9f0644c 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2950,18 +2976,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -3003,7 +3033,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3172,6 +3202,7 @@ "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" }, "fraudOffset" : { @@ -3382,7 +3413,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3574,7 +3605,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3834,7 +3865,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4244,6 +4275,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5308,6 +5340,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5316,6 +5349,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5344,6 +5378,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5356,18 +5391,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5378,7 +5417,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5428,7 +5467,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6032,6 +6071,7 @@ "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" : { @@ -6122,6 +6162,7 @@ "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" : { @@ -6283,6 +6324,7 @@ }, "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" : { @@ -6458,7 +6500,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6789,6 +6831,7 @@ }, "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" : { @@ -6914,6 +6957,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6959,7 +7003,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7732,7 +7776,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7949,7 +7993,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index ba64f2b..ed706b3 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -507,6 +507,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -517,6 +522,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -527,6 +537,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -537,6 +552,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -547,6 +567,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2599,6 +2624,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2950,18 +2976,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -3003,7 +3033,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3172,6 +3202,7 @@ "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" }, "fraudOffset" : { @@ -3382,7 +3413,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3574,7 +3605,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3834,7 +3865,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4244,6 +4275,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5308,6 +5340,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5316,6 +5349,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5344,6 +5378,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5356,18 +5391,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5378,7 +5417,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5428,7 +5467,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6037,6 +6076,7 @@ "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" : { @@ -6127,6 +6167,7 @@ "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" : { @@ -6288,6 +6329,7 @@ }, "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" : { @@ -6463,7 +6505,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6799,6 +6841,7 @@ }, "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" : { @@ -6924,6 +6967,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6969,7 +7013,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7742,7 +7786,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7959,7 +8003,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index 66035f0..7b2a8fc 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -509,6 +509,11 @@ "400" : { "content" : { "application/json" : { + "examples" : { + "generic-400" : { + "$ref" : "#/components/examples/generic-400" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -519,6 +524,11 @@ "401" : { "content" : { "application/json" : { + "examples" : { + "generic-401" : { + "$ref" : "#/components/examples/generic-401" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -529,6 +539,11 @@ "403" : { "content" : { "application/json" : { + "examples" : { + "generic-403" : { + "$ref" : "#/components/examples/generic-403" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -539,6 +554,11 @@ "422" : { "content" : { "application/json" : { + "examples" : { + "generic-422" : { + "$ref" : "#/components/examples/generic-422" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -549,6 +569,11 @@ "500" : { "content" : { "application/json" : { + "examples" : { + "generic-500" : { + "$ref" : "#/components/examples/generic-500" + } + }, "schema" : { "$ref" : "#/components/schemas/ServiceError" } @@ -2595,6 +2620,7 @@ "properties" : { "applePayToken" : { "description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.", + "maxLength" : 10000, "type" : "string" }, "fundingSource" : { @@ -2946,18 +2972,22 @@ }, "encryptedCardNumber" : { "description" : "The encrypted card number.", + "maxLength" : 6000, "type" : "string" }, "encryptedExpiryMonth" : { "description" : "The encrypted card expiry month.", + "maxLength" : 5000, "type" : "string" }, "encryptedExpiryYear" : { "description" : "The encrypted card expiry year.", + "maxLength" : 5000, "type" : "string" }, "encryptedSecurityCode" : { "description" : "The encrypted card verification code.", + "maxLength" : 5000, "type" : "string" }, "expiryMonth" : { @@ -2999,7 +3029,7 @@ "default" : "scheme", "description" : "**scheme**", "enum" : [ - "giftcard" + "##fallback" ], "type" : "string" } @@ -3168,6 +3198,7 @@ "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" }, "fraudOffset" : { @@ -3378,7 +3409,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "balance" : { @@ -3570,7 +3601,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "expiresAt" : { @@ -3826,7 +3857,7 @@ "type" : { "description" : "The type of the action.", "enum" : [ - "sdk" + "wechatpaySDK" ], "type" : "string" }, @@ -4153,6 +4184,21 @@ "description" : "A reference that is used to uniquely identify the payment in future communications about the payment status.", "type" : "string" }, + "requiredShopperFields" : { + "x-addedInVersion" : 67, + "description" : "The fields that have to be filled in by the shopper before completing the payment.", + "items" : { + "enum" : [ + "billingAddress", + "deliveryAddress", + "shopperEmail", + "shopperName", + "telephoneNumber" + ], + "type" : "string" + }, + "type" : "array" + }, "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" @@ -4213,6 +4259,7 @@ }, "paymentData" : { "description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.", + "maxLength" : 60000, "type" : "string" }, "threeDSAuthenticationOnly" : { @@ -5277,6 +5324,7 @@ "properties" : { "MD" : { "description" : "A payment session identifier returned by the card issuer.", + "maxLength" : 5000, "type" : "string" }, "PaReq" : { @@ -5285,6 +5333,7 @@ }, "PaRes" : { "description" : "(3D) Payment Authentication Response data by the card issuer.", + "maxLength" : 10000, "type" : "string" }, "billingToken" : { @@ -5313,6 +5362,7 @@ }, "payload" : { "description" : "Payload appended to the `returnURL` as a result of the redirect.", + "maxLength" : 10000, "type" : "string" }, "paymentID" : { @@ -5325,18 +5375,22 @@ }, "redirectResult" : { "description" : "The result of the redirect as appended to the `returnURL`.", + "maxLength" : 5000, "type" : "string" }, "threeDSResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.", + "maxLength" : 10000, "type" : "string" }, "threeds2.challengeResult" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.", + "maxLength" : 50000, "type" : "string" }, "threeds2.fingerprint" : { "description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.", + "maxLength" : 100000, "type" : "string" } } @@ -5347,7 +5401,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "multibanco" + "facilypay_6x" ], "type" : "string" } @@ -5392,7 +5446,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -5957,6 +6011,7 @@ "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" : { @@ -6047,6 +6102,7 @@ "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" : { @@ -6208,6 +6264,7 @@ }, "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" : { @@ -6380,7 +6437,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "amount" : { @@ -6672,6 +6729,7 @@ }, "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" : { @@ -6797,6 +6855,7 @@ "properties" : { "payload" : { "description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.", + "maxLength" : 10000, "type" : "string" } }, @@ -6842,7 +6901,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "fraudResult" : { @@ -7615,7 +7674,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -7842,7 +7901,7 @@ "type" : { "description" : "The payment method type.", "enum" : [ - "grabpay_SG" + "grabpay_TH" ], "type" : "string" } diff --git a/json/FundService-v3.json b/json/FundService-v3.json index f5018cc..63e0587 100644 --- a/json/FundService-v3.json +++ b/json/FundService-v3.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-accountHolderBalance-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolderBalanceRequest" } @@ -111,6 +116,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-accountHolderTransactionList-basic" + }, + "specific" : { + "$ref" : "#/components/examples/post-accountHolderTransactionList-specific" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolderTransactionListRequest" } @@ -191,6 +204,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "oneOff" : { + "$ref" : "#/components/examples/post-payoutAccountHolder-oneOff" + } + }, "schema" : { "$ref" : "#/components/schemas/PayoutAccountHolderRequest" } @@ -281,6 +299,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-refundFundsTransfer-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/RefundFundsTransferRequest" } @@ -371,6 +394,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-refundNotPaidOutTransfers-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/RefundNotPaidOutTransfersRequest" } @@ -461,6 +489,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-setupBeneficiary-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/SetupBeneficiaryRequest" } @@ -551,6 +584,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-transferFunds-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/TransferFundsRequest" } @@ -952,6 +990,7 @@ }, "description" : { "description" : "A description of the payout. Maximum 35 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", + "maxLength" : 35, "type" : "string" }, "merchantReference" : { @@ -1320,7 +1359,96 @@ } }, "examples" : { - + "post-accountHolderBalance-basic" : { + "summary" : "Review the account holder balance", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" + } + }, + "post-accountHolderTransactionList-basic" : { + "summary" : "Retrieve transactions page by page", + "value" : { + "accountHolderCode" : "TestAccountHolder308260", + "transactionListsPerAccount" : [ + { + "TransactionListForAccount" : { + "accountCode" : "195752115", + "page" : 1 + } + } + ] + } + }, + "post-accountHolderTransactionList-specific" : { + "summary" : "Retrieve transactions with specific statuses.", + "value" : { + "accountHolderCode" : "TestAccountHolder423978", + "transactionStatuses" : [ + "PendingCredit", + "Credited", + "Debited" + ], + "transactionListsPerAccount" : [ + { + "TransactionListForAccount" : { + "accountCode" : "2e64b396-1200-4474-b848-0cb06b52b3c7", + "page" : 2 + } + } + ] + } + }, + "post-payoutAccountHolder-oneOff" : { + "summary" : "One-off payout", + "value" : { + "accountCode" : "118731451", + "amount" : { + "currency" : "EUR", + "value" : 99792 + }, + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "description" : "12345 – Test", + "bankAccountUUID" : "000b81aa-ae7e-4492-aa7e-72b2129dce0c" + } + }, + "post-refundFundsTransfer-basic" : { + "summary" : "Refund the fund transfer", + "value" : { + "originalReference" : "PSP_REFERENCE_OF_TRANSFER_TO_REFUND", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_REFERENCE_ID" + } + }, + "post-refundNotPaidOutTransfers-basic" : { + "summary" : "Refund last transactions", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "accountCode" : "189184578" + } + }, + "post-setupBeneficiary-basic" : { + "summary" : "Set up a beneficiary", + "value" : { + "destinationAccountCode" : "128952522", + "merchantReference" : "YOUR_REFERENCE_ID", + "sourceAccountCode" : "134498192" + } + }, + "post-transferFunds-basic" : { + "summary" : "Transfer funds from one account to another", + "value" : { + "sourceAccountCode" : "100000000", + "destinationAccountCode" : "190324759", + "amount" : { + "currency" : "EUR", + "value" : 2000 + }, + "transferCode" : "TransferCode_1" + } + } } } } \ No newline at end of file diff --git a/json/FundService-v5.json b/json/FundService-v5.json index da70c0f..db26b8b 100644 --- a/json/FundService-v5.json +++ b/json/FundService-v5.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-accountHolderBalance-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolderBalanceRequest" } @@ -111,6 +116,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-accountHolderTransactionList-basic" + }, + "specific" : { + "$ref" : "#/components/examples/post-accountHolderTransactionList-specific" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolderTransactionListRequest" } @@ -191,6 +204,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "oneOff" : { + "$ref" : "#/components/examples/post-payoutAccountHolder-oneOff" + } + }, "schema" : { "$ref" : "#/components/schemas/PayoutAccountHolderRequest" } @@ -281,6 +299,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-refundFundsTransfer-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/RefundFundsTransferRequest" } @@ -371,6 +394,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-refundNotPaidOutTransfers-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/RefundNotPaidOutTransfersRequest" } @@ -461,6 +489,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-setupBeneficiary-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/SetupBeneficiaryRequest" } @@ -551,6 +584,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-transferFunds-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/TransferFundsRequest" } @@ -1135,6 +1173,7 @@ }, "description" : { "description" : "A description of the payout. Maximum 35 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", + "maxLength" : 35, "type" : "string" }, "merchantReference" : { @@ -1550,7 +1589,92 @@ } }, "examples" : { - + "post-accountHolderBalance-basic" : { + "summary" : "Review the account holder balance", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" + } + }, + "post-accountHolderTransactionList-basic" : { + "summary" : "Retrieve transactions page by page", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "transactionListsPerAccount" : [ + { + "accountCode" : "195752115", + "page" : 1 + } + ] + } + }, + "post-accountHolderTransactionList-specific" : { + "summary" : "Retrieve transactions with specific statuses.", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "transactionStatuses" : [ + "PendingCredit", + "Credited", + "Debited" + ], + "transactionListsPerAccount" : [ + { + "accountCode" : "2e64b396-1200-4474-b848-0cb06b52b3c7", + "page" : 2 + } + ] + } + }, + "post-payoutAccountHolder-oneOff" : { + "summary" : "One-off payout", + "value" : { + "accountCode" : "118731451", + "amount" : { + "currency" : "EUR", + "value" : 99792 + }, + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "description" : "12345 – Test", + "bankAccountUUID" : "000b81aa-ae7e-4492-aa7e-72b2129dce0c" + } + }, + "post-refundFundsTransfer-basic" : { + "summary" : "Refund the fund transfer", + "value" : { + "originalReference" : "PSP_REFERENCE_OF_TRANSFER_TO_REFUND", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_REFERENCE_ID" + } + }, + "post-refundNotPaidOutTransfers-basic" : { + "summary" : "Refund last transactions", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "accountCode" : "189184578" + } + }, + "post-setupBeneficiary-basic" : { + "summary" : "Set up a beneficiary", + "value" : { + "destinationAccountCode" : "128952522", + "merchantReference" : "YOUR_REFERENCE_ID", + "sourceAccountCode" : "134498192" + } + }, + "post-transferFunds-basic" : { + "summary" : "Transfer funds from one account to another", + "value" : { + "sourceAccountCode" : "100000000", + "destinationAccountCode" : "190324759", + "amount" : { + "currency" : "EUR", + "value" : 2000 + }, + "transferCode" : "TransferCode_1" + } + } } } } \ No newline at end of file diff --git a/json/FundService-v6.json b/json/FundService-v6.json index ecf1c8b..7544463 100644 --- a/json/FundService-v6.json +++ b/json/FundService-v6.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-accountHolderBalance-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolderBalanceRequest" } @@ -111,6 +116,14 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-accountHolderTransactionList-basic" + }, + "specific" : { + "$ref" : "#/components/examples/post-accountHolderTransactionList-specific" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountHolderTransactionListRequest" } @@ -191,6 +204,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "oneOff" : { + "$ref" : "#/components/examples/post-payoutAccountHolder-oneOff" + } + }, "schema" : { "$ref" : "#/components/schemas/PayoutAccountHolderRequest" } @@ -281,6 +299,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-refundFundsTransfer-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/RefundFundsTransferRequest" } @@ -371,6 +394,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-refundNotPaidOutTransfers-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/RefundNotPaidOutTransfersRequest" } @@ -461,6 +489,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-setupBeneficiary-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/SetupBeneficiaryRequest" } @@ -551,6 +584,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-transferFunds-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/TransferFundsRequest" } @@ -1135,6 +1173,7 @@ }, "description" : { "description" : "A description of the payout. Maximum 35 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", + "maxLength" : 35, "type" : "string" }, "merchantReference" : { @@ -1550,7 +1589,92 @@ } }, "examples" : { - + "post-accountHolderBalance-basic" : { + "summary" : "Review the account holder balance", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER" + } + }, + "post-accountHolderTransactionList-basic" : { + "summary" : "Retrieve transactions page by page", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "transactionListsPerAccount" : [ + { + "accountCode" : "195752115", + "page" : 1 + } + ] + } + }, + "post-accountHolderTransactionList-specific" : { + "summary" : "Retrieve transactions with specific statuses.", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "transactionStatuses" : [ + "PendingCredit", + "Credited", + "Debited" + ], + "transactionListsPerAccount" : [ + { + "accountCode" : "2e64b396-1200-4474-b848-0cb06b52b3c7", + "page" : 2 + } + ] + } + }, + "post-payoutAccountHolder-oneOff" : { + "summary" : "One-off payout", + "value" : { + "accountCode" : "118731451", + "amount" : { + "currency" : "EUR", + "value" : 99792 + }, + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "description" : "12345 – Test", + "bankAccountUUID" : "000b81aa-ae7e-4492-aa7e-72b2129dce0c" + } + }, + "post-refundFundsTransfer-basic" : { + "summary" : "Refund the fund transfer", + "value" : { + "originalReference" : "PSP_REFERENCE_OF_TRANSFER_TO_REFUND", + "amount" : { + "currency" : "EUR", + "value" : 1000 + }, + "merchantReference" : "YOUR_REFERENCE_ID" + } + }, + "post-refundNotPaidOutTransfers-basic" : { + "summary" : "Refund last transactions", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "accountCode" : "189184578" + } + }, + "post-setupBeneficiary-basic" : { + "summary" : "Set up a beneficiary", + "value" : { + "destinationAccountCode" : "128952522", + "merchantReference" : "YOUR_REFERENCE_ID", + "sourceAccountCode" : "134498192" + } + }, + "post-transferFunds-basic" : { + "summary" : "Transfer funds from one account to another", + "value" : { + "sourceAccountCode" : "100000000", + "destinationAccountCode" : "190324759", + "amount" : { + "currency" : "EUR", + "value" : 2000 + }, + "transferCode" : "TransferCode_1" + } + } } } } \ No newline at end of file diff --git a/json/MarketPayNotificationService-v3.json b/json/MarketPayNotificationService-v3.json index afd05b6..9b4f0fc 100644 --- a/json/MarketPayNotificationService-v3.json +++ b/json/MarketPayNotificationService-v3.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/post-ACCOUNT_CLOSED-accountClosed" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountCloseNotification" } @@ -41,6 +46,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, "schema" : { "$ref" : "#/components/schemas/NotificationResponse" } @@ -2217,6 +2227,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -2457,8 +2468,7 @@ "required" : [ "accountHolderCode", "accountCode", - "refundResults", - "lastPayout" + "refundResults" ] }, "ShareholderContact" : { @@ -2948,7 +2958,42 @@ } }, "examples" : { - + "WebhookAck" : { + "summary" : "Acknowledge Webhook", + "value" : { + "notificationResponse" : "[accepted]" + } + }, + "post-ACCOUNT_CLOSED-accountClosed" : { + "summary" : "ACCOUNT CLOSED example", + "value" : { + "error" : { + "errorCode" : "000", + "message" : "test error message" + }, + "eventDate" : "2019-01-01T01:00:00+01:00", + "eventType" : "ACCOUNT_CLOSED", + "executingUserKey" : "executing-user-key", + "live" : false, + "pspReference" : "TSTPSPR0001", + "content" : { + "invalidFields" : [ + { + "errorCode" : 1, + "errorDescription" : "Field is missing", + "fieldType" : { + "field" : "AccountHolderDetails.BusinessDetails.Shareholders.unknown", + "fieldName" : "unknown", + "shareholderCode" : "SH00001" + } + } + ], + "pspReference" : "TSTPSPR0001", + "resultCode" : "Success", + "status" : "Closed" + } + } + } } } } \ No newline at end of file diff --git a/json/MarketPayNotificationService-v4.json b/json/MarketPayNotificationService-v4.json index 0dacad4..0b838d5 100644 --- a/json/MarketPayNotificationService-v4.json +++ b/json/MarketPayNotificationService-v4.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/post-ACCOUNT_CLOSED-accountClosed" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountCloseNotification" } @@ -41,6 +46,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, "schema" : { "$ref" : "#/components/schemas/NotificationResponse" } @@ -2334,6 +2344,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -2595,8 +2606,7 @@ "required" : [ "accountHolderCode", "accountCode", - "refundResults", - "lastPayout" + "refundResults" ] }, "ShareholderContact" : { @@ -3116,7 +3126,42 @@ } }, "examples" : { - + "WebhookAck" : { + "summary" : "Acknowledge Webhook", + "value" : { + "notificationResponse" : "[accepted]" + } + }, + "post-ACCOUNT_CLOSED-accountClosed" : { + "summary" : "ACCOUNT CLOSED example", + "value" : { + "error" : { + "errorCode" : "000", + "message" : "test error message" + }, + "eventDate" : "2019-01-01T01:00:00+01:00", + "eventType" : "ACCOUNT_CLOSED", + "executingUserKey" : "executing-user-key", + "live" : false, + "pspReference" : "TSTPSPR0001", + "content" : { + "invalidFields" : [ + { + "errorCode" : 1, + "errorDescription" : "Field is missing", + "fieldType" : { + "field" : "AccountHolderDetails.BusinessDetails.Shareholders.unknown", + "fieldName" : "unknown", + "shareholderCode" : "SH00001" + } + } + ], + "pspReference" : "TSTPSPR0001", + "resultCode" : "Success", + "status" : "Closed" + } + } + } } } } \ No newline at end of file diff --git a/json/MarketPayNotificationService-v5.json b/json/MarketPayNotificationService-v5.json index 9643adb..845fba0 100644 --- a/json/MarketPayNotificationService-v5.json +++ b/json/MarketPayNotificationService-v5.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/post-ACCOUNT_CLOSED-accountClosed" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountCloseNotification" } @@ -41,6 +46,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, "schema" : { "$ref" : "#/components/schemas/NotificationResponse" } @@ -2606,6 +2616,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -2898,8 +2909,7 @@ "required" : [ "accountHolderCode", "accountCode", - "refundResults", - "lastPayout" + "refundResults" ] }, "ShareholderContact" : { @@ -3537,7 +3547,42 @@ } }, "examples" : { - + "WebhookAck" : { + "summary" : "Acknowledge Webhook", + "value" : { + "notificationResponse" : "[accepted]" + } + }, + "post-ACCOUNT_CLOSED-accountClosed" : { + "summary" : "ACCOUNT CLOSED example", + "value" : { + "error" : { + "errorCode" : "000", + "message" : "test error message" + }, + "eventDate" : "2019-01-01T01:00:00+01:00", + "eventType" : "ACCOUNT_CLOSED", + "executingUserKey" : "executing-user-key", + "live" : false, + "pspReference" : "TSTPSPR0001", + "content" : { + "invalidFields" : [ + { + "errorCode" : 1, + "errorDescription" : "Field is missing", + "fieldType" : { + "field" : "AccountHolderDetails.BusinessDetails.Shareholders.unknown", + "fieldName" : "unknown", + "shareholderCode" : "SH00001" + } + } + ], + "pspReference" : "TSTPSPR0001", + "resultCode" : "Success", + "status" : "Closed" + } + } + } } } } \ No newline at end of file diff --git a/json/MarketPayNotificationService-v6.json b/json/MarketPayNotificationService-v6.json index 48fa147..0ccda27 100644 --- a/json/MarketPayNotificationService-v6.json +++ b/json/MarketPayNotificationService-v6.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/post-ACCOUNT_CLOSED-accountClosed" + } + }, "schema" : { "$ref" : "#/components/schemas/AccountCloseNotification" } @@ -41,6 +46,11 @@ "200" : { "content" : { "application/json" : { + "examples" : { + "accountClosed" : { + "$ref" : "#/components/examples/WebhookAck" + } + }, "schema" : { "$ref" : "#/components/schemas/NotificationResponse" } @@ -2632,6 +2642,7 @@ "DAILY_6PM", "DAILY_AU", "DAILY_EU", + "DAILY_SG", "DAILY_US", "DEFAULT", "EVERY_6_HOURS_FROM_MIDNIGHT", @@ -2924,8 +2935,7 @@ "required" : [ "accountHolderCode", "accountCode", - "refundResults", - "lastPayout" + "refundResults" ] }, "ShareholderContact" : { @@ -3568,7 +3578,42 @@ } }, "examples" : { - + "WebhookAck" : { + "summary" : "Acknowledge Webhook", + "value" : { + "notificationResponse" : "[accepted]" + } + }, + "post-ACCOUNT_CLOSED-accountClosed" : { + "summary" : "ACCOUNT CLOSED example", + "value" : { + "error" : { + "errorCode" : "000", + "message" : "test error message" + }, + "eventDate" : "2019-01-01T01:00:00+01:00", + "eventType" : "ACCOUNT_CLOSED", + "executingUserKey" : "executing-user-key", + "live" : false, + "pspReference" : "TSTPSPR0001", + "content" : { + "invalidFields" : [ + { + "errorCode" : 1, + "errorDescription" : "Field is missing", + "fieldType" : { + "field" : "AccountHolderDetails.BusinessDetails.Shareholders.unknown", + "fieldName" : "unknown", + "shareholderCode" : "SH00001" + } + } + ], + "pspReference" : "TSTPSPR0001", + "resultCode" : "Success", + "status" : "Closed" + } + } + } } } } \ No newline at end of file diff --git a/json/NotificationConfigurationService-v1.json b/json/NotificationConfigurationService-v1.json index 3a6840b..9a3c87d 100644 --- a/json/NotificationConfigurationService-v1.json +++ b/json/NotificationConfigurationService-v1.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/CreateNotificationConfigurationRequest" } @@ -47,6 +52,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -77,6 +132,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -107,6 +212,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -137,6 +292,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -167,6 +372,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -181,6 +436,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest" } @@ -197,6 +457,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -434,6 +744,26 @@ "includeMode" ] }, + "ServiceError" : { + "properties" : { + "errorCode" : { + "description" : "The error code mapped to the error message.", + "type" : "string" + }, + "errorType" : { + "description" : "The category of the error.", + "type" : "string" + }, + "message" : { + "description" : "A short explanation of the issue.", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference of the payment.", + "type" : "string" + } + } + }, "TestNotificationConfigurationRequest" : { "properties" : { "eventTypes" : { @@ -576,7 +906,58 @@ } }, "examples" : { - + "post-createNotificationConfiguration-basic" : { + "summary" : "Create a notification configuration", + "value" : { + "configurationDetails" : { + "active" : true, + "description" : "Test notification769551", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_VERIFICATION", + "includeMode" : "INCLUDE" + } + } + ], + "messageFormat" : "SOAP", + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName", + "notifyPassword" : "testPassword", + "sendActionHeader" : true, + "sslProtocol" : "SSL" + } + } + }, + "post-updateNotificationConfiguration-basic" : { + "summary" : "Update notification configurations", + "value" : { + "configurationDetails" : { + "active" : false, + "description" : "new description799847", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_CREATED", + "includeMode" : "EXCLUDE" + } + }, + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_CREATED", + "includeMode" : "INCLUDE" + } + } + ], + "notificationId" : 21259, + "notifyPassword" : "testPassword2", + "notifyURL" : "http://www.adyen.com", + "notifyUsername" : "testUserName2", + "sendActionHeader" : false, + "sslProtocol" : "TLSv10" + } + } + } } } } \ No newline at end of file diff --git a/json/NotificationConfigurationService-v2.json b/json/NotificationConfigurationService-v2.json index 03dd208..7bb57b3 100644 --- a/json/NotificationConfigurationService-v2.json +++ b/json/NotificationConfigurationService-v2.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/CreateNotificationConfigurationRequest" } @@ -47,6 +52,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -77,6 +132,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -107,6 +212,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -137,6 +292,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -167,6 +372,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -181,6 +436,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest" } @@ -197,6 +457,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -434,6 +744,26 @@ "includeMode" ] }, + "ServiceError" : { + "properties" : { + "errorCode" : { + "description" : "The error code mapped to the error message.", + "type" : "string" + }, + "errorType" : { + "description" : "The category of the error.", + "type" : "string" + }, + "message" : { + "description" : "A short explanation of the issue.", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference of the payment.", + "type" : "string" + } + } + }, "TestNotificationConfigurationRequest" : { "properties" : { "eventTypes" : { @@ -576,7 +906,58 @@ } }, "examples" : { - + "post-createNotificationConfiguration-basic" : { + "summary" : "Create a notification configuration", + "value" : { + "configurationDetails" : { + "active" : true, + "description" : "Test notification769551", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_VERIFICATION", + "includeMode" : "INCLUDE" + } + } + ], + "messageFormat" : "SOAP", + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName", + "notifyPassword" : "testPassword", + "sendActionHeader" : true, + "sslProtocol" : "SSL" + } + } + }, + "post-updateNotificationConfiguration-basic" : { + "summary" : "Update notification configurations", + "value" : { + "configurationDetails" : { + "active" : false, + "description" : "new description799847", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_CREATED", + "includeMode" : "EXCLUDE" + } + }, + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_CREATED", + "includeMode" : "INCLUDE" + } + } + ], + "notificationId" : 21259, + "notifyPassword" : "testPassword2", + "notifyURL" : "http://www.adyen.com", + "notifyUsername" : "testUserName2", + "sendActionHeader" : false, + "sslProtocol" : "TLSv10" + } + } + } } } } \ No newline at end of file diff --git a/json/NotificationConfigurationService-v3.json b/json/NotificationConfigurationService-v3.json index ecfd86d..0cd72e5 100644 --- a/json/NotificationConfigurationService-v3.json +++ b/json/NotificationConfigurationService-v3.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/CreateNotificationConfigurationRequest" } @@ -47,6 +52,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -77,6 +132,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -107,6 +212,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -137,6 +292,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -167,6 +372,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -181,6 +436,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest" } @@ -197,6 +457,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -434,6 +744,26 @@ "includeMode" ] }, + "ServiceError" : { + "properties" : { + "errorCode" : { + "description" : "The error code mapped to the error message.", + "type" : "string" + }, + "errorType" : { + "description" : "The category of the error.", + "type" : "string" + }, + "message" : { + "description" : "A short explanation of the issue.", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference of the payment.", + "type" : "string" + } + } + }, "TestNotificationConfigurationRequest" : { "properties" : { "eventTypes" : { @@ -576,7 +906,58 @@ } }, "examples" : { - + "post-createNotificationConfiguration-basic" : { + "summary" : "Create a notification configuration", + "value" : { + "configurationDetails" : { + "active" : true, + "description" : "Test notification769551", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_VERIFICATION", + "includeMode" : "INCLUDE" + } + } + ], + "messageFormat" : "SOAP", + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName", + "notifyPassword" : "testPassword", + "sendActionHeader" : true, + "sslProtocol" : "SSL" + } + } + }, + "post-updateNotificationConfiguration-basic" : { + "summary" : "Update notification configurations", + "value" : { + "configurationDetails" : { + "active" : false, + "description" : "new description799847", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_CREATED", + "includeMode" : "EXCLUDE" + } + }, + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_CREATED", + "includeMode" : "INCLUDE" + } + } + ], + "notificationId" : 21259, + "notifyPassword" : "testPassword2", + "notifyURL" : "http://www.adyen.com", + "notifyUsername" : "testUserName2", + "sendActionHeader" : false, + "sslProtocol" : "TLSv10" + } + } + } } } } \ No newline at end of file diff --git a/json/NotificationConfigurationService-v4.json b/json/NotificationConfigurationService-v4.json index 38af6c8..cb87014 100644 --- a/json/NotificationConfigurationService-v4.json +++ b/json/NotificationConfigurationService-v4.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/CreateNotificationConfigurationRequest" } @@ -47,6 +52,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -77,6 +132,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -107,6 +212,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -137,6 +292,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -167,6 +372,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -181,6 +436,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest" } @@ -197,6 +457,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -434,6 +744,26 @@ "includeMode" ] }, + "ServiceError" : { + "properties" : { + "errorCode" : { + "description" : "The error code mapped to the error message.", + "type" : "string" + }, + "errorType" : { + "description" : "The category of the error.", + "type" : "string" + }, + "message" : { + "description" : "A short explanation of the issue.", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference of the payment.", + "type" : "string" + } + } + }, "TestNotificationConfigurationRequest" : { "properties" : { "eventTypes" : { @@ -576,7 +906,58 @@ } }, "examples" : { - + "post-createNotificationConfiguration-basic" : { + "summary" : "Create a notification configuration", + "value" : { + "configurationDetails" : { + "active" : true, + "description" : "Test notification769551", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_VERIFICATION", + "includeMode" : "INCLUDE" + } + } + ], + "messageFormat" : "SOAP", + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName", + "notifyPassword" : "testPassword", + "sendActionHeader" : true, + "sslProtocol" : "SSL" + } + } + }, + "post-updateNotificationConfiguration-basic" : { + "summary" : "Update notification configurations", + "value" : { + "configurationDetails" : { + "active" : false, + "description" : "new description799847", + "eventConfigs" : [ + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_HOLDER_CREATED", + "includeMode" : "EXCLUDE" + } + }, + { + "NotificationEventConfiguration" : { + "eventType" : "ACCOUNT_CREATED", + "includeMode" : "INCLUDE" + } + } + ], + "notificationId" : 21259, + "notifyPassword" : "testPassword2", + "notifyURL" : "http://www.adyen.com", + "notifyUsername" : "testUserName2", + "sendActionHeader" : false, + "sslProtocol" : "TLSv10" + } + } + } } } } \ No newline at end of file diff --git a/json/NotificationConfigurationService-v5.json b/json/NotificationConfigurationService-v5.json index 8d69224..ab98e1f 100644 --- a/json/NotificationConfigurationService-v5.json +++ b/json/NotificationConfigurationService-v5.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/CreateNotificationConfigurationRequest" } @@ -47,6 +52,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -77,6 +132,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -107,6 +212,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -137,6 +292,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -167,6 +372,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -181,6 +436,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest" } @@ -197,6 +457,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -599,6 +909,26 @@ "includeMode" ] }, + "ServiceError" : { + "properties" : { + "errorCode" : { + "description" : "The error code mapped to the error message.", + "type" : "string" + }, + "errorType" : { + "description" : "The category of the error.", + "type" : "string" + }, + "message" : { + "description" : "A short explanation of the issue.", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference of the payment.", + "type" : "string" + } + } + }, "TestNotificationConfigurationRequest" : { "properties" : { "eventTypes" : { @@ -745,7 +1075,49 @@ } }, "examples" : { - + "post-createNotificationConfiguration-basic" : { + "summary" : "Create a notification configuration", + "value" : { + "configurationDetails" : { + "active" : true, + "description" : "Unique description 123", + "eventConfigs" : [ + { + "eventType" : "ACCOUNT_HOLDER_VERIFICATION", + "includeMode" : "INCLUDE" + } + ], + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName", + "notifyPassword" : "testPassword", + "sslProtocol" : "SSL" + } + } + }, + "post-updateNotificationConfiguration-basic" : { + "summary" : "Update notification configurations", + "value" : { + "configurationDetails" : { + "active" : false, + "description" : "Test notif config 756", + "eventConfigs" : [ + { + "eventType" : "ACCOUNT_HOLDER_CREATED", + "includeMode" : "EXCLUDE" + }, + { + "eventType" : "ACCOUNT_CREATED", + "includeMode" : "INCLUDE" + } + ], + "notificationId" : 21259, + "notifyPassword" : "testPassword2", + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName2", + "sslProtocol" : "TLSv10" + } + } + } } } } \ No newline at end of file diff --git a/json/NotificationConfigurationService-v6.json b/json/NotificationConfigurationService-v6.json index a98dcd1..0a75b99 100644 --- a/json/NotificationConfigurationService-v6.json +++ b/json/NotificationConfigurationService-v6.json @@ -31,6 +31,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-createNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/CreateNotificationConfigurationRequest" } @@ -47,6 +52,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -77,6 +132,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -107,6 +212,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -137,6 +292,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -167,6 +372,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -181,6 +436,11 @@ "requestBody" : { "content" : { "application/json" : { + "examples" : { + "basic" : { + "$ref" : "#/components/examples/post-updateNotificationConfiguration-basic" + } + }, "schema" : { "$ref" : "#/components/schemas/UpdateNotificationConfigurationRequest" } @@ -197,6 +457,56 @@ } }, "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." } } } @@ -599,6 +909,26 @@ "includeMode" ] }, + "ServiceError" : { + "properties" : { + "errorCode" : { + "description" : "The error code mapped to the error message.", + "type" : "string" + }, + "errorType" : { + "description" : "The category of the error.", + "type" : "string" + }, + "message" : { + "description" : "A short explanation of the issue.", + "type" : "string" + }, + "pspReference" : { + "description" : "The PSP reference of the payment.", + "type" : "string" + } + } + }, "TestNotificationConfigurationRequest" : { "properties" : { "eventTypes" : { @@ -745,7 +1075,49 @@ } }, "examples" : { - + "post-createNotificationConfiguration-basic" : { + "summary" : "Create a notification configuration", + "value" : { + "configurationDetails" : { + "active" : true, + "description" : "Unique description 123", + "eventConfigs" : [ + { + "eventType" : "ACCOUNT_HOLDER_VERIFICATION", + "includeMode" : "INCLUDE" + } + ], + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName", + "notifyPassword" : "testPassword", + "sslProtocol" : "SSL" + } + } + }, + "post-updateNotificationConfiguration-basic" : { + "summary" : "Update notification configurations", + "value" : { + "configurationDetails" : { + "active" : false, + "description" : "Test notif config 756", + "eventConfigs" : [ + { + "eventType" : "ACCOUNT_HOLDER_CREATED", + "includeMode" : "EXCLUDE" + }, + { + "eventType" : "ACCOUNT_CREATED", + "includeMode" : "INCLUDE" + } + ], + "notificationId" : 21259, + "notifyPassword" : "testPassword2", + "notifyURL" : "https://www.adyen.com/notification-handler", + "notifyUsername" : "testUserName2", + "sslProtocol" : "TLSv10" + } + } + } } } } \ No newline at end of file diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 26763aa..701e4bb 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -2240,6 +2240,7 @@ "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" }, "entityType" : { @@ -2490,6 +2491,7 @@ "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" }, "fraudOffset" : { @@ -2661,7 +2663,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2686,6 +2688,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index 7f5aa0b..8f5df3e 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -2514,6 +2514,7 @@ "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" }, "entityType" : { @@ -2774,6 +2775,7 @@ "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" }, "fraudOffset" : { @@ -2955,7 +2957,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2980,6 +2982,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 8514099..13708ca 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -2359,14 +2359,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3152,6 +3144,7 @@ "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" }, "entityType" : { @@ -3445,6 +3438,7 @@ "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" }, "fraudOffset" : { @@ -3723,6 +3717,7 @@ "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" }, "fraudOffset" : { @@ -3927,7 +3922,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -3952,6 +3947,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index 9435db4..7bdd4a9 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -2369,14 +2369,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3172,6 +3164,7 @@ "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" }, "entityType" : { @@ -3465,6 +3458,7 @@ "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" }, "fraudOffset" : { @@ -3743,6 +3737,7 @@ "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" }, "fraudOffset" : { @@ -3947,7 +3942,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -3972,6 +3967,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -4567,7 +4563,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 10f03e6..df8f517 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -2369,14 +2369,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3172,6 +3164,7 @@ "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" }, "entityType" : { @@ -3465,6 +3458,7 @@ "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" }, "fraudOffset" : { @@ -3743,6 +3737,7 @@ "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" }, "fraudOffset" : { @@ -3947,7 +3942,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -3972,6 +3967,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -4567,7 +4563,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 231bf22..d53ed04 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -2379,14 +2379,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3182,6 +3174,7 @@ "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" }, "entityType" : { @@ -3481,6 +3474,7 @@ "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" }, "fraudOffset" : { @@ -3765,6 +3759,7 @@ "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" }, "fraudOffset" : { @@ -3975,7 +3970,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -4000,6 +3995,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -4595,7 +4591,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index 3447e07..28b7ab6 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -2488,14 +2488,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3291,6 +3283,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3596,6 +3589,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3886,6 +3880,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -4102,7 +4097,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -4127,6 +4122,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -4722,7 +4718,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index 12a28d0..ed0a75a 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -2488,14 +2488,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3291,6 +3283,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3604,6 +3597,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3894,6 +3888,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -4110,7 +4105,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -4135,6 +4130,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -4730,7 +4726,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 22d46f4..ed17476 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -2488,14 +2488,6 @@ "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.", "type" : "string" }, - "splits" : { - "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" - }, - "type" : "array" - }, "tenderReference" : { "x-addedInVersion" : 25, "description" : "The transaction reference provided by the PED. For point-of-sale integrations only.", @@ -3300,6 +3292,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3613,6 +3606,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -3903,6 +3897,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -4119,7 +4114,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -4144,6 +4139,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -4739,7 +4735,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PayoutService-v30.json b/json/PayoutService-v30.json index 4aca941..1689696 100644 --- a/json/PayoutService-v30.json +++ b/json/PayoutService-v30.json @@ -2010,6 +2010,7 @@ "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" }, "entityType" : { @@ -2210,7 +2211,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2235,6 +2236,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { diff --git a/json/PayoutService-v40.json b/json/PayoutService-v40.json index ee9d0a9..18c1a0a 100644 --- a/json/PayoutService-v40.json +++ b/json/PayoutService-v40.json @@ -2344,6 +2344,7 @@ "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" }, "entityType" : { @@ -2567,7 +2568,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2592,6 +2593,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { diff --git a/json/PayoutService-v50.json b/json/PayoutService-v50.json index 98c1d7f..47d116e 100644 --- a/json/PayoutService-v50.json +++ b/json/PayoutService-v50.json @@ -2354,6 +2354,7 @@ "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" }, "entityType" : { @@ -2583,7 +2584,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2608,6 +2609,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -3093,7 +3095,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PayoutService-v51.json b/json/PayoutService-v51.json index 0f25398..49261dc 100644 --- a/json/PayoutService-v51.json +++ b/json/PayoutService-v51.json @@ -2354,6 +2354,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -2589,7 +2590,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2614,6 +2615,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -3099,7 +3101,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PayoutService-v52.json b/json/PayoutService-v52.json index bfa3856..9c58323 100644 --- a/json/PayoutService-v52.json +++ b/json/PayoutService-v52.json @@ -2354,6 +2354,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -2597,7 +2598,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2622,6 +2623,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -3107,7 +3109,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/PayoutService-v64.json b/json/PayoutService-v64.json index 195af63..374e221 100644 --- a/json/PayoutService-v64.json +++ b/json/PayoutService-v64.json @@ -2363,6 +2363,7 @@ "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" }, "enableRealTimeUpdate" : { @@ -2606,7 +2607,7 @@ "$ref" : "#/components/schemas/ResponseAdditionalDataSepa" } ], - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.", "type" : "object" }, "authCode" : { @@ -2631,6 +2632,7 @@ }, "md" : { "description" : "The payment session.", + "maxLength" : 10000, "type" : "string" }, "paRequest" : { @@ -3116,7 +3118,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/RecurringService-v49.json b/json/RecurringService-v49.json index d652435..c0c296b 100644 --- a/json/RecurringService-v49.json +++ b/json/RecurringService-v49.json @@ -694,7 +694,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : {