From 0fa3eb89a2717fdd423860cff2588e65f0d7edbb Mon Sep 17 00:00:00 2001 From: aleksei Date: Fri, 26 Mar 2021 14:55:21 +0100 Subject: [PATCH] Updated YAML specs --- yaml/AccountService-v3.yaml | 166 +++--- yaml/AccountService-v4.yaml | 166 +++--- yaml/AccountService-v5.yaml | 179 +++---- yaml/AccountService-v6.yaml | 179 +++---- yaml/BalancePlatformService-v1.yaml | 489 ++++++++++++++++++ yaml/BinLookupService-v50.yaml | 6 +- yaml/CheckoutService-v37.yaml | 74 ++- yaml/CheckoutService-v40.yaml | 75 ++- yaml/CheckoutService-v41.yaml | 75 ++- yaml/CheckoutService-v46.yaml | 81 ++- yaml/CheckoutService-v49.yaml | 83 ++- yaml/CheckoutService-v50.yaml | 83 ++- yaml/CheckoutService-v51.yaml | 83 ++- yaml/CheckoutService-v52.yaml | 83 ++- yaml/CheckoutService-v53.yaml | 83 ++- yaml/CheckoutService-v64.yaml | 83 ++- yaml/CheckoutService-v65.yaml | 83 ++- yaml/CheckoutService-v66.yaml | 83 ++- yaml/CheckoutService-v67.yaml | 96 +++- yaml/FundService-v3.yaml | 88 +++- yaml/FundService-v5.yaml | 86 ++- yaml/FundService-v6.yaml | 86 ++- yaml/MarketPayNotificationService-v3.yaml | 36 +- yaml/MarketPayNotificationService-v4.yaml | 36 +- yaml/MarketPayNotificationService-v5.yaml | 36 +- yaml/MarketPayNotificationService-v6.yaml | 36 +- yaml/NotificationConfigurationService-v1.yaml | 237 ++++++++- yaml/NotificationConfigurationService-v2.yaml | 237 ++++++++- yaml/NotificationConfigurationService-v3.yaml | 237 ++++++++- yaml/NotificationConfigurationService-v4.yaml | 237 ++++++++- yaml/NotificationConfigurationService-v5.yaml | 231 ++++++++- yaml/NotificationConfigurationService-v6.yaml | 231 ++++++++- yaml/PaymentService-v25.yaml | 10 +- yaml/PaymentService-v30.yaml | 10 +- yaml/PaymentService-v40.yaml | 19 +- yaml/PaymentService-v46.yaml | 25 +- yaml/PaymentService-v49.yaml | 25 +- yaml/PaymentService-v50.yaml | 25 +- yaml/PaymentService-v51.yaml | 25 +- yaml/PaymentService-v52.yaml | 25 +- yaml/PaymentService-v64.yaml | 25 +- yaml/PayoutService-v30.yaml | 9 +- yaml/PayoutService-v40.yaml | 9 +- yaml/PayoutService-v50.yaml | 15 +- yaml/PayoutService-v51.yaml | 15 +- yaml/PayoutService-v52.yaml | 15 +- yaml/PayoutService-v64.yaml | 15 +- yaml/RecurringService-v49.yaml | 6 +- 48 files changed, 3446 insertions(+), 891 deletions(-) diff --git a/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml index c732ab4..5bc3d8a 100644 --- a/yaml/AccountService-v3.yaml +++ b/yaml/AccountService-v3.yaml @@ -62,11 +62,10 @@ x-groups: 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 @@ -123,11 +122,12 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -184,9 +184,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -244,10 +244,11 @@ paths: /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 @@ -322,11 +323,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -384,8 +382,7 @@ paths: /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 @@ -443,7 +440,7 @@ paths: /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 @@ -503,13 +500,17 @@ paths: /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' responses: @@ -558,12 +559,10 @@ paths: /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. + 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). - - For further information regarding KYC Verification, refer to [Verification - checks](https://docs.adyen.com/platforms/verification-checks).' + ' operationId: post-getUploadedDocuments x-groupName: Verification x-sortIndex: 2 @@ -620,11 +619,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -681,15 +678,15 @@ paths: description: Internal Server Error - the server could not process the request. /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. + 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. - However, 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.' + You 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 @@ -746,9 +743,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -805,38 +801,21 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: - summary: Update an existing account holder. - description: 'This endpoint is used to update the `accountHolderDetails` or - `processingTier` of an account holder. - - - If 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: - - * `accountHolderDetails.address` - - * `accountHolderDetails.fullPhoneNumber` - - * `accountHolderDetails.bankAccountDetails.BankAccountDetail` - - * `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). - - - Note that this endpoint can also be used to create new bank accounts. For - this, provide details of a bank account without providing a `bankAccountUUID`. - - - Similarly, it can also be used to create new shareholders by providing details - of a shareholder without providing a `shareholderCode`. - - > 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 @@ -899,13 +878,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -962,13 +937,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -1631,6 +1602,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2288,6 +2260,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2663,6 +2636,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2881,6 +2855,7 @@ components: gender: MALE lastName: Carpenter email: test@adyen.com + webAddress: https://www.your-website.com legalEntity: Business post-createAccountHolder-business-200: summary: Response code 200. Success. @@ -2970,6 +2945,7 @@ components: firstName: Tim gender: MALE lastName: Green + webAddress: https://www.your-website.com legalEntity: Individual post-createAccountHolder-individual-200: summary: Response code 200. Success. @@ -3055,6 +3031,12 @@ components: summary: Get an account holder for the account value: 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/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index 01ed8e0..a0cdcbe 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -62,11 +62,10 @@ x-groups: 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 @@ -123,11 +122,12 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -184,9 +184,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -244,10 +244,11 @@ paths: /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 @@ -306,11 +307,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -368,8 +366,7 @@ paths: /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 @@ -427,7 +424,7 @@ paths: /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 @@ -487,13 +484,17 @@ paths: /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' responses: @@ -542,12 +543,10 @@ paths: /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. + 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). - - For further information regarding KYC Verification, refer to [Verification - checks](https://docs.adyen.com/platforms/verification-checks).' + ' operationId: post-getUploadedDocuments x-groupName: Verification x-sortIndex: 2 @@ -604,11 +603,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -665,15 +662,15 @@ paths: description: Internal Server Error - the server could not process the request. /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. + 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. - However, 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.' + You 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 @@ -730,9 +727,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -789,38 +785,21 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: - summary: Update an existing account holder. - description: 'This endpoint is used to update the `accountHolderDetails` or - `processingTier` of an account holder. - - - If 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: - - * `accountHolderDetails.address` - - * `accountHolderDetails.fullPhoneNumber` - - * `accountHolderDetails.bankAccountDetails.BankAccountDetail` - - * `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). - - - Note that this endpoint can also be used to create new bank accounts. For - this, provide details of a bank account without providing a `bankAccountUUID`. - - - Similarly, it can also be used to create new shareholders by providing details - of a shareholder without providing a `shareholderCode`. - - > 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 @@ -883,13 +862,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -946,13 +921,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -1660,6 +1631,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2334,6 +2306,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2744,6 +2717,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2965,6 +2939,7 @@ components: lastName: Carpenter email: testshareholder@adyen.com email: test@adyen.com + webAddress: https://www.your-website.com legalEntity: Business post-createAccountHolder-individual: summary: Create an individual account holder @@ -2979,6 +2954,7 @@ components: lastName: Green address: country: US + webAddress: https://www.your-website.com legalEntity: Individual post-deleteBankAccounts-basic: summary: Delete bank accounts @@ -3000,6 +2976,12 @@ components: summary: Get an account holder for the account value: 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/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index 5748df1..5a9f1c9 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -62,9 +62,9 @@ x-groups: 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 @@ -122,11 +122,10 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -183,11 +182,12 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -244,9 +244,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -304,10 +304,11 @@ paths: /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 @@ -366,11 +367,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -427,11 +425,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -490,8 +485,7 @@ paths: /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 @@ -549,7 +543,7 @@ paths: /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 @@ -609,13 +603,17 @@ paths: /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' responses: @@ -664,12 +662,10 @@ paths: /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. + 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). - - For further information regarding KYC Verification, refer to [Verification - checks](https://docs.adyen.com/platforms/verification-checks).' + ' operationId: post-getUploadedDocuments x-groupName: Verification x-sortIndex: 2 @@ -726,11 +722,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -787,15 +781,15 @@ paths: description: Internal Server Error - the server could not process the request. /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. + 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. - However, 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.' + You 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 @@ -852,9 +846,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -911,38 +904,21 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: - summary: Update an existing account holder. - description: 'This endpoint is used to update the `accountHolderDetails` or - `processingTier` of an account holder. - - - If 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: - - * `accountHolderDetails.address` - - * `accountHolderDetails.fullPhoneNumber` - - * `accountHolderDetails.bankAccountDetails.BankAccountDetail` - - * `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). - - - Note that this endpoint can also be used to create new bank accounts. For - this, provide details of a bank account without providing a `bankAccountUUID`. - - - Similarly, it can also be used to create new shareholders by providing details - of a shareholder without providing a `shareholderCode`. - - > 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 @@ -1005,13 +981,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -1068,13 +1040,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -1864,6 +1832,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2607,6 +2576,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -3190,6 +3160,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -3396,6 +3367,7 @@ components: country: NL email: testshareholder@email.com email: test@email.com + webAddress: https://www.your-website.com legalEntity: Business post-createAccountHolder-individual: summary: Create an individual account holder @@ -3410,6 +3382,7 @@ components: lastName: Green address: country: US + webAddress: https://www.your-website.com legalEntity: Individual post-deleteBankAccounts-basic: summary: Delete bank accounts @@ -3437,6 +3410,12 @@ components: summary: Get an account holder for the account value: 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/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index e4a9343..6c2a8e9 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -62,9 +62,9 @@ x-groups: 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 @@ -122,11 +122,10 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -183,11 +182,12 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -244,9 +244,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -304,10 +304,11 @@ paths: /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 @@ -366,11 +367,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -427,11 +425,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -490,8 +485,7 @@ paths: /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 @@ -549,7 +543,7 @@ paths: /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 @@ -609,13 +603,17 @@ paths: /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' responses: @@ -664,12 +662,10 @@ paths: /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. + 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). - - For further information regarding KYC Verification, refer to [Verification - checks](https://docs.adyen.com/platforms/verification-checks).' + ' operationId: post-getUploadedDocuments x-groupName: Verification x-sortIndex: 2 @@ -726,11 +722,9 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -787,15 +781,15 @@ paths: description: Internal Server Error - the server could not process the request. /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. + 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. - However, 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.' + You 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 @@ -852,9 +846,8 @@ paths: description: Internal Server Error - the server could not process the request. /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 @@ -911,38 +904,21 @@ paths: description: Internal Server Error - the server could not process the request. /updateAccountHolder: post: - summary: Update an existing account holder. - description: 'This endpoint is used to update the `accountHolderDetails` or - `processingTier` of an account holder. - - - If 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: - - * `accountHolderDetails.address` - - * `accountHolderDetails.fullPhoneNumber` - - * `accountHolderDetails.bankAccountDetails.BankAccountDetail` - - * `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). - - - Note that this endpoint can also be used to create new bank accounts. For - this, provide details of a bank account without providing a `bankAccountUUID`. - - - Similarly, it can also be used to create new shareholders by providing details - of a shareholder without providing a `shareholderCode`. - - > 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 @@ -1005,13 +981,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -1068,13 +1040,9 @@ paths: description: Internal Server Error - the server could not process the request. /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. - - - For 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 @@ -1888,6 +1856,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2620,6 +2589,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -3211,6 +3181,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -3417,6 +3388,7 @@ components: country: NL email: testshareholder@email.com email: test@email.com + webAddress: https://www.your-website.com legalEntity: Business post-createAccountHolder-individual: summary: Create an individual account holder @@ -3431,6 +3403,7 @@ components: lastName: Green address: country: US + webAddress: https://www.your-website.com legalEntity: Individual post-deleteBankAccounts-basic: summary: Delete bank accounts @@ -3458,6 +3431,12 @@ components: summary: Get an account holder for the account value: 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/yaml/BalancePlatformService-v1.yaml b/yaml/BalancePlatformService-v1.yaml index 0fc54e3..a7afc46 100644 --- a/yaml/BalancePlatformService-v1.yaml +++ b/yaml/BalancePlatformService-v1.yaml @@ -132,36 +132,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-accountHolders-id-success-200' schema: $ref: '#/components/schemas/AccountHolder' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -287,36 +305,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-accountHolders-id-balanceAccounts-success-200' schema: $ref: '#/components/schemas/PaginatedBalanceAccountsResponse' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -412,36 +448,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-balanceAccounts-id-success-200' schema: $ref: '#/components/schemas/BalanceAccount' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -482,36 +536,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200' schema: $ref: '#/components/schemas/PaginatedPaymentInstrumentsResponse' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -534,36 +606,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-balancePlatforms-id-success-200' schema: $ref: '#/components/schemas/BalancePlatform' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -604,36 +694,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-balancePlatforms-id-accountHolders-success-200' schema: $ref: '#/components/schemas/PaginatedAccountHoldersResponse' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -801,30 +909,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -995,30 +1118,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -1188,36 +1326,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-paymentInstrumentGroups-id-success-200' schema: $ref: '#/components/schemas/PaymentInstrumentGroup' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1241,36 +1397,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200' schema: $ref: '#/components/schemas/TransactionRulesResponse' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1368,36 +1542,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-paymentInstruments-id-success-200' schema: $ref: '#/components/schemas/PaymentInstrument' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1505,36 +1697,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-paymentInstruments-id-transactionRules-success-200' schema: $ref: '#/components/schemas/TransactionRulesResponse' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1704,36 +1914,54 @@ paths: '200': content: application/json: + examples: + success-200: + $ref: '#/components/examples/get-transactionRules-transactionRuleId-success-200' schema: $ref: '#/components/schemas/TransactionRuleResponse' description: OK - the request has succeeded. '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. @@ -1984,30 +2212,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2096,6 +2339,7 @@ components: $ref: '#/components/schemas/ContactDetails' description: description: Your description for the account holder, maximum 300 characters. + maxLength: 300 type: string id: description: Unique identifier of the account holder. @@ -2110,6 +2354,7 @@ components: type: string reference: description: Your reference to the account holder, maximum 150 characters. + maxLength: 150 type: string status: description: "The status of the account holder.\n\nPossible values: \n\n\ @@ -2154,6 +2399,7 @@ components: $ref: '#/components/schemas/ContactDetails' description: description: Your description for the account holder, maximum 300 characters. + maxLength: 300 type: string legalEntityId: description: 'The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) @@ -2165,6 +2411,7 @@ components: type: string reference: description: Your reference to the account holder, maximum 150 characters. + maxLength: 150 type: string sweepConfigurations: additionalProperties: @@ -2339,6 +2586,7 @@ components: description: A human-readable description of the balance account, maximum 300 characters. You can use this parameter to help distinguish between multiple balance accounts under an account holder. + maxLength: 300 type: string id: description: Unique identifier of the balance account. @@ -2351,6 +2599,7 @@ components: type: array reference: description: Your reference to the balance account, maximum 150 characters. + maxLength: 150 type: string status: description: "The status of the balance account, set to **Active** by default.\ @@ -2392,9 +2641,11 @@ components: 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: additionalProperties: @@ -2418,6 +2669,7 @@ components: properties: description: description: A description of the balance platform, maximum 300 characters. + maxLength: 300 type: string id: description: Unique identifier of the balance platform. @@ -3089,6 +3341,7 @@ components: $ref: '#/components/schemas/Card' description: description: Your description for the payment instrument, maximum 300 characters. + maxLength: 300 type: string id: description: Unique identifier of the payment instrument. @@ -3104,6 +3357,7 @@ components: type: string reference: description: Your reference to the payment instrument, maximum 150 characters. + maxLength: 150 type: string status: description: "The status of the payment instrument. If a status is not specified\ @@ -3156,6 +3410,7 @@ components: description: description: Your description for the payment instrument group, maximum 300 characters. + maxLength: 300 type: string id: description: Unique identifier of the payment instrument group. @@ -3168,6 +3423,7 @@ components: reference: description: Your reference to the payment instrument group, maximum 150 characters. + maxLength: 150 type: string txVariant: description: The tx variant of the payment instrument group. @@ -3184,6 +3440,7 @@ components: description: description: Your description for the payment instrument group, maximum 300 characters. + maxLength: 300 type: string properties: additionalProperties: @@ -3193,6 +3450,7 @@ components: reference: description: Your reference to the payment instrument group, maximum 150 characters. + maxLength: 150 type: string txVariant: description: The tx variant of the payment instrument group. @@ -3211,6 +3469,7 @@ components: $ref: '#/components/schemas/CardInfo' description: description: Your description for the payment instrument, maximum 300 characters. + maxLength: 300 type: string issuingCountryCode: description: Country where the payment instrument is being issued, in the @@ -3223,6 +3482,7 @@ components: type: string reference: description: Your reference to the payment instrument, maximum 150 characters. + maxLength: 150 type: string status: description: "The status of the payment instrument. If a status is not specified\ @@ -3513,6 +3773,7 @@ components: type: array description: description: Your description for the transaction rule, maximum 300 characters. + maxLength: 300 type: string endDate: description: 'The date when the rule will stop being evaluated, in ISO 8601 @@ -3585,6 +3846,7 @@ components: type: array reference: description: Your reference for the transaction rule, maximum 150 characters. + maxLength: 150 type: string startDate: description: "The date when the rule will start to be evaluated, in ISO\ @@ -3638,6 +3900,7 @@ components: type: array description: description: Your description for the transaction rule, maximum 300 characters. + maxLength: 300 type: string endDate: description: 'The date when the rule will stop being evaluated, in ISO 8601 @@ -3707,6 +3970,7 @@ components: type: array reference: description: Your reference for the transaction rule, maximum 150 characters. + maxLength: 150 type: string startDate: description: "The date when the rule will start to be evaluated, in ISO\ @@ -3909,6 +4173,231 @@ components: detail: Error while determining the payment instrument workflow requestId: 1W1UHY5O2CONU4R7 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 diff --git a/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml index e2880c9..8246a51 100644 --- a/yaml/BinLookupService-v50.yaml +++ b/yaml/BinLookupService-v50.yaml @@ -464,9 +464,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index d82ba94..20bef09 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2534,6 +2549,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -2787,15 +2803,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -2827,7 +2847,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -2938,6 +2958,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3169,10 +3190,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3300,10 +3320,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3664,6 +3683,7 @@ components: 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 required: - details @@ -4346,12 +4366,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -4374,6 +4396,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -4384,18 +4407,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -4403,7 +4430,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -4422,10 +4449,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: When non-empty, contains all the fields that you must submit @@ -4957,6 +4983,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5162,6 +5189,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -5291,10 +5319,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: When non-empty, contains all the fields that you must submit @@ -5651,6 +5678,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -5792,6 +5820,7 @@ components: 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 required: - payload @@ -5811,10 +5840,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'The authorisation code representing the authentication result. @@ -6883,7 +6911,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 243d374..6a96f85 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2706,6 +2721,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3005,15 +3021,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3045,7 +3065,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3168,6 +3188,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3412,10 +3433,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3543,10 +3563,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3907,6 +3926,7 @@ components: 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: x-addedInVersion: 40 @@ -4715,12 +4735,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -4743,6 +4765,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -4753,18 +4776,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -4772,7 +4799,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -4791,10 +4818,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -5345,6 +5371,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5455,6 +5482,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -5565,6 +5593,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -5700,10 +5729,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -6072,6 +6100,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6213,6 +6242,7 @@ components: 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 required: - payload @@ -6232,10 +6262,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7310,7 +7339,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 4f37f14..c80c19f 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2714,6 +2729,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3013,15 +3029,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3053,7 +3073,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3176,6 +3196,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3420,10 +3441,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3551,10 +3571,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3915,6 +3934,7 @@ components: 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: x-addedInVersion: 40 @@ -4723,12 +4743,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -4751,6 +4773,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -4761,18 +4784,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -4780,7 +4807,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -4799,10 +4826,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -5357,6 +5383,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5467,6 +5494,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -5577,6 +5605,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -5712,10 +5741,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -6088,6 +6116,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6229,6 +6258,7 @@ components: 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 required: - payload @@ -6248,10 +6278,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7326,7 +7355,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 5dde3dd..ae9c8ed 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2714,6 +2729,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3013,15 +3029,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3053,7 +3073,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3176,6 +3196,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3420,10 +3441,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3551,10 +3571,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3915,6 +3934,7 @@ components: 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: x-addedInVersion: 40 @@ -4723,12 +4743,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -4751,6 +4773,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -4761,18 +4784,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -4780,7 +4807,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -4799,10 +4826,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -5357,6 +5383,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5467,6 +5494,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -5577,6 +5605,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -5712,10 +5741,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -6088,6 +6116,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6229,6 +6258,7 @@ components: 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 required: - payload @@ -6248,10 +6278,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7166,9 +7195,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -7334,7 +7363,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 8152f03..3989bb3 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2730,6 +2745,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3053,15 +3069,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3101,7 +3121,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3244,6 +3264,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3488,10 +3509,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3657,10 +3677,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3896,7 +3915,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4269,6 +4288,7 @@ components: 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: x-addedInVersion: 40 @@ -5141,12 +5161,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5169,6 +5191,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5179,18 +5202,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5198,7 +5225,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5221,10 +5248,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -5807,6 +5833,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5917,6 +5944,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6027,6 +6055,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6181,10 +6210,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -6573,6 +6601,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6719,6 +6748,7 @@ components: 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 required: - payload @@ -6738,10 +6768,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7686,9 +7715,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -7897,7 +7926,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 3e07338..a653ff1 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3072,15 +3088,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3120,7 +3140,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3263,6 +3283,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3513,10 +3534,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3682,10 +3702,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3921,7 +3940,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4299,6 +4318,7 @@ components: 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: x-addedInVersion: 40 @@ -5171,12 +5191,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5199,6 +5221,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5209,18 +5232,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5228,7 +5255,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5251,10 +5278,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -5842,6 +5868,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5952,6 +5979,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6062,6 +6090,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6222,10 +6251,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -6614,6 +6642,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6766,6 +6795,7 @@ components: 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 required: - payload @@ -6785,10 +6815,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7733,9 +7762,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -7944,7 +7973,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 6fa199d..e3765c4 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3072,15 +3088,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3120,7 +3140,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3263,6 +3283,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3519,10 +3540,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3688,10 +3708,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3927,7 +3946,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4305,6 +4324,7 @@ components: 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: x-addedInVersion: 40 @@ -5177,12 +5197,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5205,6 +5227,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5215,18 +5238,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5234,7 +5261,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5257,10 +5284,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -5860,6 +5886,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5976,6 +6003,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6086,6 +6114,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6246,10 +6275,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 40 @@ -6644,6 +6672,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6796,6 +6825,7 @@ components: 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 required: - payload @@ -6815,10 +6845,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7763,9 +7792,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -7974,7 +8003,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 925c8b8..ea476fc 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3072,15 +3088,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3120,7 +3140,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3263,6 +3283,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3519,10 +3540,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3688,10 +3708,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3927,7 +3946,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4305,6 +4324,7 @@ components: 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: x-addedInVersion: 40 @@ -5177,12 +5197,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5205,6 +5227,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5215,18 +5238,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5234,7 +5261,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5257,10 +5284,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -5864,6 +5890,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5980,6 +6007,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6090,6 +6118,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6250,10 +6279,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -6652,6 +6680,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6804,6 +6833,7 @@ components: 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 required: - payload @@ -6823,10 +6853,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7771,9 +7800,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -7982,7 +8011,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index e0b9088..ebe154d 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3072,15 +3088,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3120,7 +3140,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3263,6 +3283,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3519,10 +3540,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3688,10 +3708,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3927,7 +3946,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4305,6 +4324,7 @@ components: 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: x-addedInVersion: 40 @@ -5177,12 +5197,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5205,6 +5227,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5215,18 +5238,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5234,7 +5261,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5257,10 +5284,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -5876,6 +5902,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5992,6 +6019,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6102,6 +6130,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6262,10 +6291,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -6664,6 +6692,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6816,6 +6845,7 @@ components: 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 required: - payload @@ -6835,10 +6865,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7789,9 +7818,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -8000,7 +8029,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index a8871f6..8d2e873 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3072,15 +3088,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3120,7 +3140,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3263,6 +3283,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3519,10 +3540,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3688,10 +3708,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3927,7 +3946,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4305,6 +4324,7 @@ components: 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: x-addedInVersion: 40 @@ -5224,12 +5244,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5252,6 +5274,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5262,18 +5285,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5281,7 +5308,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5304,10 +5331,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -5942,6 +5968,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -6058,6 +6085,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6168,6 +6196,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6328,10 +6357,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -6744,6 +6772,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6896,6 +6925,7 @@ components: 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 required: - payload @@ -6915,10 +6945,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7869,9 +7898,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -8080,7 +8109,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 2030b5b..6a624d8 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3084,15 +3100,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3132,7 +3152,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3275,6 +3295,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3525,10 +3546,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3699,10 +3719,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3938,7 +3957,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4320,6 +4339,7 @@ components: 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: x-addedInVersion: 40 @@ -5239,12 +5259,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5267,6 +5289,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5277,18 +5300,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5296,7 +5323,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5319,10 +5346,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -5932,6 +5958,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -6042,6 +6069,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6152,6 +6180,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6312,10 +6341,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -6722,6 +6750,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6874,6 +6903,7 @@ components: 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 required: - payload @@ -6893,10 +6923,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7865,9 +7894,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -8076,7 +8105,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index a554213..70c295d 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -377,30 +377,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2749,6 +2764,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3084,15 +3100,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3132,7 +3152,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3275,6 +3295,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3525,10 +3546,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3699,10 +3719,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3938,7 +3957,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4320,6 +4339,7 @@ components: 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: x-addedInVersion: 40 @@ -5239,12 +5259,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5267,6 +5289,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5277,18 +5300,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5296,7 +5323,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5319,10 +5346,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -5936,6 +5962,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -6046,6 +6073,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6156,6 +6184,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6316,10 +6345,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -6730,6 +6758,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6882,6 +6911,7 @@ components: 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 required: - payload @@ -6901,10 +6931,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7873,9 +7902,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -8084,7 +8113,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index a504eb4..a3b12ba 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -379,30 +379,45 @@ paths: '400': content: application/json: + examples: + generic-400: + $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: + examples: + generic-401: + $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: + examples: + generic-403: + $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: + examples: + generic-422: + $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: + examples: + generic-500: + $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. @@ -2747,6 +2762,7 @@ components: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + maxLength: 10000 type: string fundingSource: description: The funding source that should be used when multiple sources @@ -3082,15 +3098,19 @@ components: type: string 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: description: The card expiry month. Only collect raw card data if you are @@ -3130,7 +3150,7 @@ components: default: scheme description: '**scheme**' enum: - - giftcard + - '##fallback' type: string required: - encryptedCardNumber @@ -3273,6 +3293,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3523,10 +3544,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The balance for the payment method. @@ -3697,10 +3717,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The date that the order will expire. @@ -3932,7 +3951,7 @@ components: type: description: The type of the action. enum: - - sdk + - wechatpaySDK type: string url: description: Specifies the URL to redirect to. @@ -4233,6 +4252,19 @@ components: 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. @@ -4297,6 +4329,7 @@ components: 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: x-addedInVersion: 40 @@ -5216,12 +5249,14 @@ components: properties: MD: description: A payment session identifier returned by the card issuer. + maxLength: 5000 type: string PaReq: description: (3D) Payment Authentication Request data for the card issuer. type: string PaRes: description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 10000 type: string billingToken: description: PayPal-generated token for recurring payments. @@ -5244,6 +5279,7 @@ components: type: string payload: description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 10000 type: string paymentID: description: PayPal-generated ID for the payment. @@ -5254,18 +5290,22 @@ components: type: string 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 PaymentDetails: additionalProperties: false @@ -5273,7 +5313,7 @@ components: type: description: The payment method type. enum: - - multibanco + - facilypay_6x type: string title: Payment Details PaymentDetailsResponse: @@ -5292,10 +5332,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -5869,6 +5908,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableOneClick: x-addedInVersion: 32 @@ -5979,6 +6019,7 @@ components: Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.' + maxLength: 8000 type: string paymentMethod: description: The type and required details of a payment method to use. @@ -6089,6 +6130,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6248,10 +6290,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: x-addedInVersion: 52 @@ -6622,6 +6663,7 @@ components: can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' + maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify @@ -6774,6 +6816,7 @@ components: 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 required: - payload @@ -6793,10 +6836,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: The fraud result properties of the payment. @@ -7765,9 +7807,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. @@ -7984,7 +8026,7 @@ components: type: description: The payment method type. enum: - - grabpay_SG + - grabpay_TH type: string title: Stored Payment Method SubInputDetail: diff --git a/yaml/FundService-v3.yaml b/yaml/FundService-v3.yaml index 7dfe4bd..1517a63 100644 --- a/yaml/FundService-v3.yaml +++ b/yaml/FundService-v3.yaml @@ -70,6 +70,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-accountHolderBalance-basic' schema: $ref: '#/components/schemas/AccountHolderBalanceRequest' responses: @@ -124,6 +127,11 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-accountHolderTransactionList-basic' + specific: + $ref: '#/components/examples/post-accountHolderTransactionList-specific' schema: $ref: '#/components/schemas/AccountHolderTransactionListRequest' responses: @@ -174,6 +182,9 @@ paths: requestBody: content: application/json: + examples: + oneOff: + $ref: '#/components/examples/post-payoutAccountHolder-oneOff' schema: $ref: '#/components/schemas/PayoutAccountHolderRequest' responses: @@ -232,6 +243,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-refundFundsTransfer-basic' schema: $ref: '#/components/schemas/RefundFundsTransferRequest' responses: @@ -294,6 +308,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-refundNotPaidOutTransfers-basic' schema: $ref: '#/components/schemas/RefundNotPaidOutTransfersRequest' responses: @@ -356,6 +373,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-setupBeneficiary-basic' schema: $ref: '#/components/schemas/SetupBeneficiaryRequest' responses: @@ -415,6 +435,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-transferFunds-basic' schema: $ref: '#/components/schemas/TransferFundsRequest' responses: @@ -904,6 +927,7 @@ components: Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**' + maxLength: 35 type: string merchantReference: x-addedInVersion: 2 @@ -1248,4 +1272,66 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 \u2013 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 diff --git a/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml index a32e4eb..73dbeb6 100644 --- a/yaml/FundService-v5.yaml +++ b/yaml/FundService-v5.yaml @@ -70,6 +70,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-accountHolderBalance-basic' schema: $ref: '#/components/schemas/AccountHolderBalanceRequest' responses: @@ -124,6 +127,11 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-accountHolderTransactionList-basic' + specific: + $ref: '#/components/examples/post-accountHolderTransactionList-specific' schema: $ref: '#/components/schemas/AccountHolderTransactionListRequest' responses: @@ -174,6 +182,9 @@ paths: requestBody: content: application/json: + examples: + oneOff: + $ref: '#/components/examples/post-payoutAccountHolder-oneOff' schema: $ref: '#/components/schemas/PayoutAccountHolderRequest' responses: @@ -232,6 +243,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-refundFundsTransfer-basic' schema: $ref: '#/components/schemas/RefundFundsTransferRequest' responses: @@ -294,6 +308,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-refundNotPaidOutTransfers-basic' schema: $ref: '#/components/schemas/RefundNotPaidOutTransfersRequest' responses: @@ -356,6 +373,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-setupBeneficiary-basic' schema: $ref: '#/components/schemas/SetupBeneficiaryRequest' responses: @@ -415,6 +435,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-transferFunds-basic' schema: $ref: '#/components/schemas/TransferFundsRequest' responses: @@ -1058,6 +1081,7 @@ components: Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**' + maxLength: 35 type: string merchantReference: x-addedInVersion: 2 @@ -1409,4 +1433,64 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 \u2013 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 diff --git a/yaml/FundService-v6.yaml b/yaml/FundService-v6.yaml index 3a4dce5..4972cb0 100644 --- a/yaml/FundService-v6.yaml +++ b/yaml/FundService-v6.yaml @@ -70,6 +70,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-accountHolderBalance-basic' schema: $ref: '#/components/schemas/AccountHolderBalanceRequest' responses: @@ -124,6 +127,11 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-accountHolderTransactionList-basic' + specific: + $ref: '#/components/examples/post-accountHolderTransactionList-specific' schema: $ref: '#/components/schemas/AccountHolderTransactionListRequest' responses: @@ -174,6 +182,9 @@ paths: requestBody: content: application/json: + examples: + oneOff: + $ref: '#/components/examples/post-payoutAccountHolder-oneOff' schema: $ref: '#/components/schemas/PayoutAccountHolderRequest' responses: @@ -232,6 +243,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-refundFundsTransfer-basic' schema: $ref: '#/components/schemas/RefundFundsTransferRequest' responses: @@ -294,6 +308,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-refundNotPaidOutTransfers-basic' schema: $ref: '#/components/schemas/RefundNotPaidOutTransfersRequest' responses: @@ -356,6 +373,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-setupBeneficiary-basic' schema: $ref: '#/components/schemas/SetupBeneficiaryRequest' responses: @@ -415,6 +435,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-transferFunds-basic' schema: $ref: '#/components/schemas/TransferFundsRequest' responses: @@ -1058,6 +1081,7 @@ components: Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**' + maxLength: 35 type: string merchantReference: x-addedInVersion: 2 @@ -1409,4 +1433,64 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 \u2013 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 diff --git a/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml index 5c6b265..a5aba90 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -32,12 +32,18 @@ paths: requestBody: content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/post-ACCOUNT_CLOSED-accountClosed' schema: $ref: '#/components/schemas/AccountCloseNotification' responses: '200': content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/WebhookAck' schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. @@ -1915,6 +1921,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2115,7 +2122,6 @@ components: - accountHolderCode - accountCode - refundResults - - lastPayout ShareholderContact: properties: address: @@ -2609,4 +2615,30 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index 08bbc19..cc28c81 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -32,12 +32,18 @@ paths: requestBody: content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/post-ACCOUNT_CLOSED-accountClosed' schema: $ref: '#/components/schemas/AccountCloseNotification' responses: '200': content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/WebhookAck' schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. @@ -2017,6 +2023,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2235,7 +2242,6 @@ components: - accountHolderCode - accountCode - refundResults - - lastPayout ShareholderContact: properties: address: @@ -2754,4 +2760,30 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index 904b601..642e546 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -32,12 +32,18 @@ paths: requestBody: content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/post-ACCOUNT_CLOSED-accountClosed' schema: $ref: '#/components/schemas/AccountCloseNotification' responses: '200': content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/WebhookAck' schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. @@ -2235,6 +2241,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2480,7 +2487,6 @@ components: - accountHolderCode - accountCode - refundResults - - lastPayout ShareholderContact: properties: address: @@ -3104,4 +3110,30 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index b0d4dd8..fdbba7d 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -32,12 +32,18 @@ paths: requestBody: content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/post-ACCOUNT_CLOSED-accountClosed' schema: $ref: '#/components/schemas/AccountCloseNotification' responses: '200': content: application/json: + examples: + accountClosed: + $ref: '#/components/examples/WebhookAck' schema: $ref: '#/components/schemas/NotificationResponse' description: OK - the request has succeeded. @@ -2259,6 +2265,7 @@ components: - DAILY_6PM - DAILY_AU - DAILY_EU + - DAILY_SG - DAILY_US - DEFAULT - EVERY_6_HOURS_FROM_MIDNIGHT @@ -2504,7 +2511,6 @@ components: - accountHolderCode - accountCode - refundResults - - lastPayout ShareholderContact: properties: address: @@ -3132,4 +3138,30 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/NotificationConfigurationService-v1.yaml b/yaml/NotificationConfigurationService-v1.yaml index 375721a..ccf6692 100644 --- a/yaml/NotificationConfigurationService-v1.yaml +++ b/yaml/NotificationConfigurationService-v1.yaml @@ -75,6 +75,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: @@ -84,6 +87,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /deleteNotificationConfigurations: post: summary: Delete an existing notification subscription configuration. @@ -105,6 +138,36 @@ paths: schema: $ref: '#/components/schemas/GenericResponse' 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. /getNotificationConfiguration: post: summary: Retrieve an existing notification subscription configuration. @@ -125,6 +188,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /getNotificationConfigurationList: post: summary: Retrieve a list of existing notification subscription configurations. @@ -146,6 +239,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationListResponse' 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. /testNotificationConfiguration: post: summary: Test an existing notification configuration. @@ -167,6 +290,36 @@ paths: schema: $ref: '#/components/schemas/TestNotificationConfigurationResponse' 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. /updateNotificationConfiguration: post: summary: Update an existing notification subscription configuration. @@ -179,6 +332,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/UpdateNotificationConfigurationRequest' responses: @@ -188,6 +344,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. components: schemas: CreateNotificationConfigurationRequest: @@ -412,6 +598,20 @@ components: required: - eventType - 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: @@ -546,4 +746,39 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/NotificationConfigurationService-v2.yaml b/yaml/NotificationConfigurationService-v2.yaml index b1a80ad..90e9de9 100644 --- a/yaml/NotificationConfigurationService-v2.yaml +++ b/yaml/NotificationConfigurationService-v2.yaml @@ -75,6 +75,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: @@ -84,6 +87,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /deleteNotificationConfigurations: post: summary: Delete an existing notification subscription configuration. @@ -105,6 +138,36 @@ paths: schema: $ref: '#/components/schemas/GenericResponse' 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. /getNotificationConfiguration: post: summary: Retrieve an existing notification subscription configuration. @@ -125,6 +188,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /getNotificationConfigurationList: post: summary: Retrieve a list of existing notification subscription configurations. @@ -146,6 +239,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationListResponse' 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. /testNotificationConfiguration: post: summary: Test an existing notification configuration. @@ -167,6 +290,36 @@ paths: schema: $ref: '#/components/schemas/TestNotificationConfigurationResponse' 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. /updateNotificationConfiguration: post: summary: Update an existing notification subscription configuration. @@ -179,6 +332,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/UpdateNotificationConfigurationRequest' responses: @@ -188,6 +344,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. components: schemas: CreateNotificationConfigurationRequest: @@ -412,6 +598,20 @@ components: required: - eventType - 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: @@ -546,4 +746,39 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/NotificationConfigurationService-v3.yaml b/yaml/NotificationConfigurationService-v3.yaml index fb54493..b02e0b0 100644 --- a/yaml/NotificationConfigurationService-v3.yaml +++ b/yaml/NotificationConfigurationService-v3.yaml @@ -75,6 +75,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: @@ -84,6 +87,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /deleteNotificationConfigurations: post: summary: Delete an existing notification subscription configuration. @@ -105,6 +138,36 @@ paths: schema: $ref: '#/components/schemas/GenericResponse' 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. /getNotificationConfiguration: post: summary: Retrieve an existing notification subscription configuration. @@ -125,6 +188,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /getNotificationConfigurationList: post: summary: Retrieve a list of existing notification subscription configurations. @@ -146,6 +239,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationListResponse' 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. /testNotificationConfiguration: post: summary: Test an existing notification configuration. @@ -167,6 +290,36 @@ paths: schema: $ref: '#/components/schemas/TestNotificationConfigurationResponse' 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. /updateNotificationConfiguration: post: summary: Update an existing notification subscription configuration. @@ -179,6 +332,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/UpdateNotificationConfigurationRequest' responses: @@ -188,6 +344,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. components: schemas: CreateNotificationConfigurationRequest: @@ -412,6 +598,20 @@ components: required: - eventType - 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: @@ -546,4 +746,39 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/NotificationConfigurationService-v4.yaml b/yaml/NotificationConfigurationService-v4.yaml index 772ee18..3594dc9 100644 --- a/yaml/NotificationConfigurationService-v4.yaml +++ b/yaml/NotificationConfigurationService-v4.yaml @@ -75,6 +75,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: @@ -84,6 +87,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /deleteNotificationConfigurations: post: summary: Delete an existing notification subscription configuration. @@ -105,6 +138,36 @@ paths: schema: $ref: '#/components/schemas/GenericResponse' 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. /getNotificationConfiguration: post: summary: Retrieve an existing notification subscription configuration. @@ -125,6 +188,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /getNotificationConfigurationList: post: summary: Retrieve a list of existing notification subscription configurations. @@ -146,6 +239,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationListResponse' 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. /testNotificationConfiguration: post: summary: Test an existing notification configuration. @@ -167,6 +290,36 @@ paths: schema: $ref: '#/components/schemas/TestNotificationConfigurationResponse' 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. /updateNotificationConfiguration: post: summary: Update an existing notification subscription configuration. @@ -179,6 +332,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/UpdateNotificationConfigurationRequest' responses: @@ -188,6 +344,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. components: schemas: CreateNotificationConfigurationRequest: @@ -412,6 +598,20 @@ components: required: - eventType - 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: @@ -546,4 +746,39 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml index d32bee3..4d938b5 100644 --- a/yaml/NotificationConfigurationService-v5.yaml +++ b/yaml/NotificationConfigurationService-v5.yaml @@ -75,6 +75,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: @@ -84,6 +87,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /deleteNotificationConfigurations: post: summary: Delete an existing notification subscription configuration. @@ -105,6 +138,36 @@ paths: schema: $ref: '#/components/schemas/GenericResponse' 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. /getNotificationConfiguration: post: summary: Retrieve an existing notification subscription configuration. @@ -125,6 +188,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /getNotificationConfigurationList: post: summary: Retrieve a list of existing notification subscription configurations. @@ -146,6 +239,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationListResponse' 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. /testNotificationConfiguration: post: summary: Test an existing notification configuration. @@ -167,6 +290,36 @@ paths: schema: $ref: '#/components/schemas/TestNotificationConfigurationResponse' 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. /updateNotificationConfiguration: post: summary: Update an existing notification subscription configuration. @@ -179,6 +332,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/UpdateNotificationConfigurationRequest' responses: @@ -188,6 +344,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. components: schemas: CreateNotificationConfigurationRequest: @@ -555,6 +741,20 @@ components: required: - eventType - 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: @@ -685,4 +885,33 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/NotificationConfigurationService-v6.yaml b/yaml/NotificationConfigurationService-v6.yaml index b583477..6431dcc 100644 --- a/yaml/NotificationConfigurationService-v6.yaml +++ b/yaml/NotificationConfigurationService-v6.yaml @@ -75,6 +75,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-createNotificationConfiguration-basic' schema: $ref: '#/components/schemas/CreateNotificationConfigurationRequest' responses: @@ -84,6 +87,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /deleteNotificationConfigurations: post: summary: Delete an existing notification subscription configuration. @@ -105,6 +138,36 @@ paths: schema: $ref: '#/components/schemas/GenericResponse' 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. /getNotificationConfiguration: post: summary: Retrieve an existing notification subscription configuration. @@ -125,6 +188,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. /getNotificationConfigurationList: post: summary: Retrieve a list of existing notification subscription configurations. @@ -146,6 +239,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationListResponse' 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. /testNotificationConfiguration: post: summary: Test an existing notification configuration. @@ -167,6 +290,36 @@ paths: schema: $ref: '#/components/schemas/TestNotificationConfigurationResponse' 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. /updateNotificationConfiguration: post: summary: Update an existing notification subscription configuration. @@ -179,6 +332,9 @@ paths: requestBody: content: application/json: + examples: + basic: + $ref: '#/components/examples/post-updateNotificationConfiguration-basic' schema: $ref: '#/components/schemas/UpdateNotificationConfigurationRequest' responses: @@ -188,6 +344,36 @@ paths: schema: $ref: '#/components/schemas/GetNotificationConfigurationResponse' 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. components: schemas: CreateNotificationConfigurationRequest: @@ -555,6 +741,20 @@ components: required: - eventType - 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: @@ -685,4 +885,33 @@ components: BasicAuth: scheme: basic type: http - examples: {} + 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 diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index d181dee..70d1395 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -2590,6 +2590,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -2879,6 +2880,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3081,10 +3083,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3117,6 +3118,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 74b6ac8..17d3ac7 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -2789,6 +2789,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3095,6 +3096,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -3314,10 +3316,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3350,6 +3351,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 337f55d..745d138 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -2673,14 +2673,6 @@ components: Maximum 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 @@ -3411,6 +3403,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3754,6 +3747,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4085,6 +4079,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4328,10 +4323,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4364,6 +4358,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index 09f005b..213ab6b 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -2683,14 +2683,6 @@ components: Maximum 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 @@ -3431,6 +3423,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3774,6 +3767,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4105,6 +4099,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4348,10 +4343,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4384,6 +4378,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -5208,9 +5203,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 4b011bc..ca516be 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -2683,14 +2683,6 @@ components: Maximum 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 @@ -3431,6 +3423,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3774,6 +3767,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4105,6 +4099,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4348,10 +4343,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4384,6 +4378,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -5208,9 +5203,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index 4639204..6766d4b 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -2700,14 +2700,6 @@ components: Maximum 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 @@ -3448,6 +3440,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3797,6 +3790,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4134,6 +4128,7 @@ components: 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: description: An integer value that is added to the normal fraud score. The @@ -4383,10 +4378,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4419,6 +4413,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -5243,9 +5238,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 3127c17..c3e7bb1 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -2772,14 +2772,6 @@ components: Maximum 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 @@ -3520,6 +3512,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3875,6 +3868,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -4218,6 +4212,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -4473,10 +4468,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4509,6 +4503,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -5333,9 +5328,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 947943b..73ebe4a 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -2772,14 +2772,6 @@ components: Maximum 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 @@ -3520,6 +3512,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3883,6 +3876,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -4226,6 +4220,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -4481,10 +4476,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4517,6 +4511,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -5341,9 +5336,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index b331b47..542dc41 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -2772,14 +2772,6 @@ components: Maximum 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 @@ -3535,6 +3527,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3898,6 +3891,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -4241,6 +4235,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -4496,10 +4491,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -4532,6 +4526,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -5356,9 +5351,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index 05c16b0..c63131b 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -2369,6 +2369,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -2603,10 +2604,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -2639,6 +2639,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index 6f439cd..9c5c9e5 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -2759,6 +2759,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3018,10 +3019,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3054,6 +3054,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index 0d5a8a5..bde0e2b 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -2776,6 +2776,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string entityType: x-addedInVersion: 24 @@ -3041,10 +3042,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3077,6 +3077,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3815,9 +3816,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index a5d4bdb..3764c2d 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -2776,6 +2776,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3047,10 +3048,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3083,6 +3083,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3821,9 +3822,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index 13d6970..7400042 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -2776,6 +2776,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3055,10 +3056,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3091,6 +3091,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3829,9 +3830,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index 4f3df00..4b280c7 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -2791,6 +2791,7 @@ components: x-addedInVersion: 2 description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 type: string enableRealTimeUpdate: x-addedInVersion: 51 @@ -3070,10 +3071,9 @@ components: - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataPayPal' - $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: description: 'Authorisation code: @@ -3106,6 +3106,7 @@ components: type: string md: description: The payment session. + maxLength: 10000 type: string paRequest: description: 'The 3D request data for the issuer. @@ -3844,9 +3845,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message. diff --git a/yaml/RecurringService-v49.yaml b/yaml/RecurringService-v49.yaml index fc55579..2a18ad1 100644 --- a/yaml/RecurringService-v49.yaml +++ b/yaml/RecurringService-v49.yaml @@ -663,9 +663,9 @@ components: x-addedInVersion: 46 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: description: The error code mapped to the error message.