diff --git a/json/AccountService-v3.json b/json/AccountService-v3.json index f2658f4..3f574d9 100644 --- a/json/AccountService-v3.json +++ b/json/AccountService-v3.json @@ -9,7 +9,7 @@ "version" : "3", "x-publicVersion" : true, "title" : "Account API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v3/createAccountHolder\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v3/createAccountHolder\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -152,7 +152,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", "operationId" : "post-closeAccountHolder", "x-sortIndex" : 7, "x-methodName" : "closeAccountHolder", @@ -270,7 +270,7 @@ "Accounts" ], "summary" : "Create an account", - "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", + "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-sortIndex" : 1, "x-methodName" : "createAccount", @@ -388,7 +388,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/classic-platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", "x-sortIndex" : 1, "x-methodName" : "createAccountHolder", @@ -1130,7 +1130,7 @@ "Account holders" ], "summary" : "Get a tax form", - "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).", + "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms).", "operationId" : "post-getTaxForm", "x-sortIndex" : 8, "x-methodName" : "getTaxForm", @@ -1238,7 +1238,7 @@ "Verification" ], "summary" : "Get documents", - "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n", + "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-sortIndex" : 2, "x-methodName" : "getUploadedDocuments", @@ -1346,7 +1346,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", "x-sortIndex" : 5, "x-methodName" : "suspendAccountHolder", @@ -1464,7 +1464,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", "x-sortIndex" : 6, "x-methodName" : "unSuspendAccountHolder", @@ -1945,7 +1945,7 @@ "Verification" ], "summary" : "Upload a document", - "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).", "operationId" : "post-uploadDocument", "x-sortIndex" : 1, "x-methodName" : "uploadDocument", @@ -2086,7 +2086,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -2120,7 +2120,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetailWrapper" }, @@ -2297,11 +2297,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -2313,31 +2313,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -2345,15 +2345,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -2362,27 +2362,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -2390,11 +2390,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -2426,7 +2426,7 @@ "type" : "array" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContactWrapper" }, @@ -2549,7 +2549,7 @@ }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" } @@ -2782,7 +2782,7 @@ }, "bankAccountUUID" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", + "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, "description" : { @@ -2790,7 +2790,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", + "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", "enum" : [ "BANK_STATEMENT", "BSN", @@ -2812,7 +2812,7 @@ }, "shareholderCode" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", + "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, "signatoryCode" : { @@ -4007,7 +4007,7 @@ "type" : "string" }, "documentContent" : { - "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).", + "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).", "format" : "byte", "type" : "string" }, diff --git a/json/AccountService-v4.json b/json/AccountService-v4.json index 9b202b9..d399570 100644 --- a/json/AccountService-v4.json +++ b/json/AccountService-v4.json @@ -9,7 +9,7 @@ "version" : "4", "x-publicVersion" : true, "title" : "Account API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v4/createAccountHolder\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v4/createAccountHolder\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -152,7 +152,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", "operationId" : "post-closeAccountHolder", "x-sortIndex" : 7, "x-methodName" : "closeAccountHolder", @@ -270,7 +270,7 @@ "Accounts" ], "summary" : "Create an account", - "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", + "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-sortIndex" : 1, "x-methodName" : "createAccount", @@ -388,7 +388,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/classic-platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", "x-sortIndex" : 1, "x-methodName" : "createAccountHolder", @@ -1112,7 +1112,7 @@ "Account holders" ], "summary" : "Get a tax form", - "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).", + "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms).", "operationId" : "post-getTaxForm", "x-sortIndex" : 8, "x-methodName" : "getTaxForm", @@ -1220,7 +1220,7 @@ "Verification" ], "summary" : "Get documents", - "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n", + "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-sortIndex" : 2, "x-methodName" : "getUploadedDocuments", @@ -1328,7 +1328,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", "x-sortIndex" : 5, "x-methodName" : "suspendAccountHolder", @@ -1446,7 +1446,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", "x-sortIndex" : 6, "x-methodName" : "unSuspendAccountHolder", @@ -1941,7 +1941,7 @@ "Verification" ], "summary" : "Upload a document", - "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).", "operationId" : "post-uploadDocument", "x-sortIndex" : 1, "x-methodName" : "uploadDocument", @@ -2092,7 +2092,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -2126,7 +2126,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetailWrapper" }, @@ -2303,11 +2303,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -2319,31 +2319,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -2351,15 +2351,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -2368,27 +2368,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -2396,11 +2396,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -2437,7 +2437,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContactWrapper" }, @@ -2571,7 +2571,7 @@ }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" } @@ -2829,7 +2829,7 @@ }, "bankAccountUUID" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", + "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, "description" : { @@ -2837,7 +2837,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", + "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", "enum" : [ "BANK_STATEMENT", "BSN", @@ -2859,7 +2859,7 @@ }, "shareholderCode" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", + "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, "signatoryCode" : { @@ -4108,7 +4108,7 @@ "type" : "string" }, "documentContent" : { - "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).", + "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).", "format" : "byte", "type" : "string" }, diff --git a/json/AccountService-v5.json b/json/AccountService-v5.json index ffb7861..f5960e5 100644 --- a/json/AccountService-v5.json +++ b/json/AccountService-v5.json @@ -9,7 +9,7 @@ "version" : "5", "x-publicVersion" : true, "title" : "Account API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v5/createAccountHolder\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v5/createAccountHolder\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -271,7 +271,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", "operationId" : "post-closeAccountHolder", "x-sortIndex" : 7, "x-methodName" : "closeAccountHolder", @@ -493,7 +493,7 @@ "Accounts" ], "summary" : "Create an account", - "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", + "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-sortIndex" : 1, "x-methodName" : "createAccount", @@ -611,7 +611,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/classic-platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", "x-sortIndex" : 1, "x-methodName" : "createAccountHolder", @@ -1454,7 +1454,7 @@ "Account holders" ], "summary" : "Get a tax form", - "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).", + "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms).", "operationId" : "post-getTaxForm", "x-sortIndex" : 8, "x-methodName" : "getTaxForm", @@ -1562,7 +1562,7 @@ "Verification" ], "summary" : "Get documents", - "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n", + "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-sortIndex" : 2, "x-methodName" : "getUploadedDocuments", @@ -1670,7 +1670,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", "x-sortIndex" : 5, "x-methodName" : "suspendAccountHolder", @@ -1788,7 +1788,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", "x-sortIndex" : 6, "x-methodName" : "unSuspendAccountHolder", @@ -2283,7 +2283,7 @@ "Verification" ], "summary" : "Upload a document", - "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).", "operationId" : "post-uploadDocument", "x-sortIndex" : 1, "x-methodName" : "uploadDocument", @@ -2462,7 +2462,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -2489,7 +2489,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -2533,7 +2533,7 @@ }, "payoutMethods" : { "x-addedInVersion" : "5", - "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, @@ -2545,7 +2545,7 @@ }, "storeDetails" : { "x-addedInVersion" : "5", - "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).", + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" }, @@ -2685,11 +2685,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -2706,31 +2706,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -2738,15 +2738,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -2755,27 +2755,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -2783,11 +2783,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -2817,7 +2817,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2985,7 +2985,7 @@ }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" } @@ -3327,7 +3327,7 @@ }, "bankAccountUUID" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", + "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, "description" : { @@ -3335,7 +3335,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", + "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", "enum" : [ "BANK_STATEMENT", "BSN", @@ -3359,7 +3359,7 @@ }, "shareholderCode" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", + "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, "signatoryCode" : { @@ -3946,7 +3946,7 @@ "properties" : { "kycCheckCode" : { "x-addedInVersion" : "5", - "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).", + "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes).", "format" : "int32", "type" : "integer" }, @@ -4149,7 +4149,7 @@ "additionalProperties" : false, "properties" : { "merchantAccount" : { - "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "payoutMethodCode" : { @@ -4161,11 +4161,11 @@ "type" : "string" }, "recurringDetailReference" : { - "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "shopperReference" : { - "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" } }, @@ -4920,7 +4920,7 @@ "additionalProperties" : false, "properties" : { "documentContent" : { - "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).", + "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).", "format" : "byte", "type" : "string" }, diff --git a/json/AccountService-v6.json b/json/AccountService-v6.json index e12da74..4fbfa1f 100644 --- a/json/AccountService-v6.json +++ b/json/AccountService-v6.json @@ -9,7 +9,7 @@ "version" : "6", "x-publicVersion" : true, "title" : "Account API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -271,7 +271,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.", "operationId" : "post-closeAccountHolder", "x-sortIndex" : 7, "x-methodName" : "closeAccountHolder", @@ -493,7 +493,7 @@ "Accounts" ], "summary" : "Create an account", - "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", + "description" : "Creates an account under an account holder. An account holder can have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-sortIndex" : 1, "x-methodName" : "createAccount", @@ -611,7 +611,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/classic-platforms/account-holders-and-accounts#legal-entity-types).", "operationId" : "post-createAccountHolder", "x-sortIndex" : 1, "x-methodName" : "createAccountHolder", @@ -1454,7 +1454,7 @@ "Account holders" ], "summary" : "Get a tax form", - "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms).", + "description" : "Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms).", "operationId" : "post-getTaxForm", "x-sortIndex" : 8, "x-methodName" : "getTaxForm", @@ -1562,7 +1562,7 @@ "Verification" ], "summary" : "Get documents", - "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).\n", + "description" : "Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-sortIndex" : 2, "x-methodName" : "getUploadedDocuments", @@ -1670,7 +1670,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", "operationId" : "post-suspendAccountHolder", "x-sortIndex" : 5, "x-methodName" : "suspendAccountHolder", @@ -1788,7 +1788,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", + "description" : "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status).", "operationId" : "post-unSuspendAccountHolder", "x-sortIndex" : 6, "x-methodName" : "unSuspendAccountHolder", @@ -2283,7 +2283,7 @@ "Verification" ], "summary" : "Upload a document", - "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "Uploads a document for an account holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process).", "operationId" : "post-uploadDocument", "x-sortIndex" : 1, "x-methodName" : "uploadDocument", @@ -2462,7 +2462,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -2489,7 +2489,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -2522,7 +2522,7 @@ }, "legalArrangements" : { "x-addedInVersion" : "6", - "description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).", + "description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements).", "items" : { "$ref" : "#/components/schemas/LegalArrangementDetail" }, @@ -2541,7 +2541,7 @@ }, "payoutMethods" : { "x-addedInVersion" : "5", - "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, @@ -2553,7 +2553,7 @@ }, "storeDetails" : { "x-addedInVersion" : "5", - "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).", + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" }, @@ -2693,11 +2693,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -2714,31 +2714,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -2746,15 +2746,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -2763,27 +2763,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -2791,11 +2791,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -2825,7 +2825,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -3010,7 +3010,7 @@ }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" }, @@ -3364,7 +3364,7 @@ }, "bankAccountUUID" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", + "description" : "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n", "type" : "string" }, "description" : { @@ -3372,7 +3372,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", + "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n", "enum" : [ "BANK_STATEMENT", "BSN", @@ -3407,7 +3407,7 @@ }, "shareholderCode" : { "x-addedInVersion" : "2", - "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", + "description" : "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ", "type" : "string" }, "signatoryCode" : { @@ -3967,7 +3967,7 @@ "properties" : { "kycCheckCode" : { "x-addedInVersion" : "5", - "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).", + "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes).", "format" : "int32", "type" : "integer" }, @@ -4211,7 +4211,7 @@ "type" : "string" }, "type" : { - "description" : "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n", + "description" : "The [type of legal arrangement](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n", "enum" : [ "Association", "Partnership", @@ -4415,7 +4415,7 @@ "additionalProperties" : false, "properties" : { "merchantAccount" : { - "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "payoutMethodCode" : { @@ -4427,11 +4427,11 @@ "type" : "string" }, "recurringDetailReference" : { - "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "shopperReference" : { - "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" } }, @@ -5200,7 +5200,7 @@ "additionalProperties" : false, "properties" : { "documentContent" : { - "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).", + "description" : "The content of the document, in Base64-encoded string format.\n\nTo learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).", "format" : "byte", "type" : "string" }, diff --git a/json/FundService-v3.json b/json/FundService-v3.json index 00c1922..dd04c3e 100644 --- a/json/FundService-v3.json +++ b/json/FundService-v3.json @@ -9,7 +9,7 @@ "version" : "3", "x-publicVersion" : true, "title" : "Fund API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v3/accountHolderBalance\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v3/accountHolderBalance\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -250,7 +250,7 @@ "General" ], "summary" : "Send a direct debit request", - "description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts).", + "description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/classic-platforms/top-up-accounts).", "operationId" : "post-debitAccountHolder", "x-sortIndex" : 8, "x-methodName" : "debitAccountHolder", @@ -1127,11 +1127,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1143,31 +1143,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1175,15 +1175,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1192,27 +1192,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -1220,11 +1220,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -1546,11 +1546,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -1558,11 +1558,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/FundService-v5.json b/json/FundService-v5.json index a642363..86afe42 100644 --- a/json/FundService-v5.json +++ b/json/FundService-v5.json @@ -9,7 +9,7 @@ "version" : "5", "x-publicVersion" : true, "title" : "Fund API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v5/accountHolderBalance\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v5/accountHolderBalance\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -250,7 +250,7 @@ "General" ], "summary" : "Send a direct debit request", - "description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts).", + "description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/classic-platforms/top-up-accounts).", "operationId" : "post-debitAccountHolder", "x-sortIndex" : 8, "x-methodName" : "debitAccountHolder", @@ -1114,11 +1114,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1135,31 +1135,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1167,15 +1167,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1184,27 +1184,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -1212,11 +1212,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -1795,11 +1795,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -1807,11 +1807,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/FundService-v6.json b/json/FundService-v6.json index ee18ba8..fc5c185 100644 --- a/json/FundService-v6.json +++ b/json/FundService-v6.json @@ -9,7 +9,7 @@ "version" : "6", "x-publicVersion" : true, "title" : "Fund API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -250,7 +250,7 @@ "General" ], "summary" : "Send a direct debit request", - "description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts).", + "description" : "Sends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED) notification webhook.\n\n To learn more about direct debits, see [Top up accounts](https://docs.adyen.com/classic-platforms/top-up-accounts).", "operationId" : "post-debitAccountHolder", "x-sortIndex" : 8, "x-methodName" : "debitAccountHolder", @@ -1114,11 +1114,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1135,31 +1135,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1167,15 +1167,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1184,27 +1184,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -1212,11 +1212,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -1795,11 +1795,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -1807,11 +1807,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/HopService-v1.json b/json/HopService-v1.json index b1b8833..1569bc5 100644 --- a/json/HopService-v1.json +++ b/json/HopService-v1.json @@ -9,7 +9,7 @@ "version" : "1", "x-publicVersion" : true, "title" : "Hosted onboarding API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v1/getOnboardingUrl\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -31,7 +31,7 @@ "Hosted Onboarding Page" ], "summary" : "Get a link to a Adyen-hosted onboarding page", - "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ", + "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", "x-sortIndex" : 1, "x-methodName" : "getOnboardingUrl", @@ -134,7 +134,7 @@ "PCI Compliance Questionnaire Page" ], "summary" : "Get a link to a PCI compliance questionnaire", - "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).", + "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", "x-sortIndex" : 1, "x-methodName" : "getPciQuestionnaireUrl", @@ -238,27 +238,27 @@ "additionalProperties" : false, "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.", "type" : "boolean" }, "legalArrangementDetails" : { - "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) must be collected. Default is **true**.", + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", "type" : "boolean" }, "pciQuestionnaire" : { - "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", + "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", "type" : "boolean" }, "shareholderDetails" : { - "description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.", + "description" : "Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.", "type" : "boolean" } }, @@ -477,7 +477,7 @@ "type" : "string" }, "collectInformation" : { - "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types).", "$ref" : "#/components/schemas/CollectInformation" }, "editMode" : { @@ -497,7 +497,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).", + "description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language).", "type" : "string" }, "showPages" : { diff --git a/json/HopService-v5.json b/json/HopService-v5.json index 302e0cf..12d963c 100644 --- a/json/HopService-v5.json +++ b/json/HopService-v5.json @@ -9,7 +9,7 @@ "version" : "5", "x-publicVersion" : true, "title" : "Hosted onboarding API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v5/getOnboardingUrl\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v5/getOnboardingUrl\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -31,7 +31,7 @@ "Hosted Onboarding Page" ], "summary" : "Get a link to a Adyen-hosted onboarding page", - "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ", + "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", "x-sortIndex" : 1, "x-methodName" : "getOnboardingUrl", @@ -134,7 +134,7 @@ "PCI Compliance Questionnaire Page" ], "summary" : "Get a link to a PCI compliance questionnaire", - "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).", + "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", "x-sortIndex" : 1, "x-methodName" : "getPciQuestionnaireUrl", @@ -238,27 +238,27 @@ "additionalProperties" : false, "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.", "type" : "boolean" }, "legalArrangementDetails" : { - "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) must be collected. Default is **true**.", + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", "type" : "boolean" }, "pciQuestionnaire" : { - "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", + "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", "type" : "boolean" }, "shareholderDetails" : { - "description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.", + "description" : "Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.", "type" : "boolean" } }, @@ -474,7 +474,7 @@ "type" : "string" }, "collectInformation" : { - "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types).", "$ref" : "#/components/schemas/CollectInformation" }, "editMode" : { @@ -494,7 +494,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).", + "description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language).", "type" : "string" }, "showPages" : { diff --git a/json/HopService-v6.json b/json/HopService-v6.json index b56dba3..859d076 100644 --- a/json/HopService-v6.json +++ b/json/HopService-v6.json @@ -9,7 +9,7 @@ "version" : "6", "x-publicVersion" : true, "title" : "Hosted onboarding API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -31,7 +31,7 @@ "Hosted Onboarding Page" ], "summary" : "Get a link to a Adyen-hosted onboarding page", - "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ", + "description" : "Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", "x-sortIndex" : 1, "x-methodName" : "getOnboardingUrl", @@ -134,7 +134,7 @@ "PCI Compliance Questionnaire Page" ], "summary" : "Get a link to a PCI compliance questionnaire", - "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).", + "description" : "Returns a link to a PCI compliance questionnaire that you can send to your account holder.\n > You should only use this endpoint if you have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", "x-sortIndex" : 1, "x-methodName" : "getPciQuestionnaireUrl", @@ -238,27 +238,27 @@ "additionalProperties" : false, "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**.", "type" : "boolean" }, "legalArrangementDetails" : { - "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) must be collected. Default is **true**.", + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", "type" : "boolean" }, "pciQuestionnaire" : { - "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", + "description" : "Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**.", "type" : "boolean" }, "shareholderDetails" : { - "description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.", + "description" : "Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**.", "type" : "boolean" } }, @@ -474,7 +474,7 @@ "type" : "string" }, "collectInformation" : { - "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).", + "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types).", "$ref" : "#/components/schemas/CollectInformation" }, "editMode" : { @@ -494,7 +494,7 @@ "type" : "string" }, "shopperLocale" : { - "description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).", + "description" : "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.\n\nFor a list of supported languages, refer to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language).", "type" : "string" }, "showPages" : { diff --git a/json/MarketPayNotificationService-v3.json b/json/MarketPayNotificationService-v3.json index 6fa0f78..384f3cf 100644 --- a/json/MarketPayNotificationService-v3.json +++ b/json/MarketPayNotificationService-v3.json @@ -4,7 +4,7 @@ "version" : "3", "x-publicVersion" : true, "title" : "Classic Platforms - Notifications", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -651,7 +651,7 @@ "Other" ], "summary" : "Booking for a capture or refund failed", - "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", + "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", "x-sortIndex" : 1, "x-methodName" : "bookingForCaptureOrRefundFailed", @@ -931,7 +931,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -1059,7 +1059,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetailWrapper" }, @@ -1643,11 +1643,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1659,31 +1659,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1691,15 +1691,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1708,27 +1708,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -1736,11 +1736,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -1840,7 +1840,7 @@ "type" : "array" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContactWrapper" }, @@ -3046,11 +3046,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -3058,11 +3058,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/MarketPayNotificationService-v4.json b/json/MarketPayNotificationService-v4.json index e80f2d5..90ba5e4 100644 --- a/json/MarketPayNotificationService-v4.json +++ b/json/MarketPayNotificationService-v4.json @@ -4,7 +4,7 @@ "version" : "4", "x-publicVersion" : true, "title" : "Classic Platforms - Notifications", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -651,7 +651,7 @@ "Other" ], "summary" : "Booking for a capture or refund failed", - "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", + "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", "x-sortIndex" : 1, "x-methodName" : "bookingForCaptureOrRefundFailed", @@ -945,7 +945,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -1087,7 +1087,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetailWrapper" }, @@ -1717,11 +1717,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1733,31 +1733,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1765,15 +1765,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1782,27 +1782,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -1810,11 +1810,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -1926,7 +1926,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContactWrapper" }, @@ -3176,11 +3176,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -3188,11 +3188,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/MarketPayNotificationService-v5.json b/json/MarketPayNotificationService-v5.json index d00f0cf..7c306e2 100644 --- a/json/MarketPayNotificationService-v5.json +++ b/json/MarketPayNotificationService-v5.json @@ -4,7 +4,7 @@ "version" : "5", "x-publicVersion" : true, "title" : "Classic Platforms - Notifications", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -658,7 +658,7 @@ "Other" ], "summary" : "Booking for a capture or refund failed", - "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", + "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", "x-sortIndex" : 1, "x-methodName" : "bookingForCaptureOrRefundFailed", @@ -967,7 +967,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -1112,7 +1112,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1156,7 +1156,7 @@ }, "payoutMethods" : { "x-addedInVersion" : "5", - "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, @@ -1168,7 +1168,7 @@ }, "storeDetails" : { "x-addedInVersion" : "5", - "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).", + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" }, @@ -1863,11 +1863,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1884,31 +1884,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1916,15 +1916,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1933,27 +1933,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -1961,11 +1961,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -2078,7 +2078,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2763,7 +2763,7 @@ "properties" : { "kycCheckCode" : { "x-addedInVersion" : "5", - "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).", + "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes).", "format" : "int32", "type" : "integer" }, @@ -2995,7 +2995,7 @@ "additionalProperties" : false, "properties" : { "merchantAccount" : { - "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "payoutMethodCode" : { @@ -3007,11 +3007,11 @@ "type" : "string" }, "recurringDetailReference" : { - "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "shopperReference" : { - "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" } }, @@ -3442,11 +3442,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -3454,11 +3454,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/MarketPayNotificationService-v6.json b/json/MarketPayNotificationService-v6.json index 5315781..059def6 100644 --- a/json/MarketPayNotificationService-v6.json +++ b/json/MarketPayNotificationService-v6.json @@ -4,7 +4,7 @@ "version" : "6", "x-publicVersion" : true, "title" : "Classic Platforms - Notifications", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification API sends notifications to the endpoints specified in a given subscription. \nSubscriptions are managed through the Notification Configuration API. The API specifications listed here detail the format of each notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -658,7 +658,7 @@ "Other" ], "summary" : "Booking for a capture or refund failed", - "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", + "description" : "Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified in the split data.", "operationId" : "post-PAYMENT_FAILURE", "x-sortIndex" : 1, "x-methodName" : "bookingForCaptureOrRefundFailed", @@ -967,7 +967,7 @@ "additionalProperties" : false, "properties" : { "event" : { - "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).", + "description" : "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).", "enum" : [ "InactivateAccount", "RefundNotPaidOutTransfers" @@ -1112,7 +1112,7 @@ "$ref" : "#/components/schemas/ViasAddress" }, "bankAccountDetails" : { - "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).", + "description" : "Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information).", "items" : { "$ref" : "#/components/schemas/BankAccountDetail" }, @@ -1145,7 +1145,7 @@ }, "legalArrangements" : { "x-addedInVersion" : "6", - "description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).", + "description" : "An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements).", "items" : { "$ref" : "#/components/schemas/LegalArrangementDetail" }, @@ -1164,7 +1164,7 @@ }, "payoutMethods" : { "x-addedInVersion" : "5", - "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).", + "description" : "Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards).", "items" : { "$ref" : "#/components/schemas/PayoutMethod" }, @@ -1176,7 +1176,7 @@ }, "storeDetails" : { "x-addedInVersion" : "5", - "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).", + "description" : "Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos).", "items" : { "$ref" : "#/components/schemas/StoreDetail" }, @@ -1909,11 +1909,11 @@ "additionalProperties" : false, "properties" : { "accountNumber" : { - "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank account number (without separators).\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "accountType" : { - "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The type of bank account.\nOnly applicable to bank accounts held in the USA.\nThe permitted values are: `checking`, `savings`.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankAccountName" : { @@ -1930,31 +1930,31 @@ "type" : "string" }, "bankBicSwift" : { - "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank identifier code.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCity" : { - "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city in which the bank branch is located.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankCode" : { - "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The bank code of the banking institution with which the bank account is registered.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "bankName" : { - "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the banking institution with which the bank account is held.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "branchCode" : { - "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "checkCode" : { - "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The check code of the bank account.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "countryCode" : { - "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The two-letter country code in which the bank account is registered.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "currencyCode" : { @@ -1962,15 +1962,15 @@ "type" : "string" }, "iban" : { - "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The international bank account number.\n>The IBAN standard is defined in ISO-13616.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCity" : { - "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The city of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerCountryCode" : { - "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of residence of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerDateOfBirth" : { @@ -1979,27 +1979,27 @@ "type" : "string" }, "ownerHouseNumberOrName" : { - "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The house name or number of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerName" : { - "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The name of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerNationality" : { - "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The country code of the country of nationality of the bank account owner.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerPostalCode" : { - "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The postal code of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerState" : { - "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The state of residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "ownerStreet" : { - "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The street name of the residence of the bank account owner.\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "primaryAccount" : { @@ -2007,11 +2007,11 @@ "type" : "boolean" }, "taxId" : { - "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The tax ID number.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" }, "urlForVerification" : { - "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.", + "description" : "The URL to be used for bank account verification.\nThis may be generated on bank account creation.\n\n>Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.", "type" : "string" } }, @@ -2124,7 +2124,7 @@ "type" : "string" }, "shareholders" : { - "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).", + "description" : "Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos).", "items" : { "$ref" : "#/components/schemas/ShareholderContact" }, @@ -2797,7 +2797,7 @@ "properties" : { "kycCheckCode" : { "x-addedInVersion" : "5", - "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).", + "description" : "The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes).", "format" : "int32", "type" : "integer" }, @@ -3041,7 +3041,7 @@ "type" : "string" }, "type" : { - "description" : "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n", + "description" : "The [type of legal arrangement](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n", "enum" : [ "Association", "Partnership", @@ -3274,7 +3274,7 @@ "additionalProperties" : false, "properties" : { "merchantAccount" : { - "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "payoutMethodCode" : { @@ -3286,11 +3286,11 @@ "type" : "string" }, "recurringDetailReference" : { - "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" }, "shopperReference" : { - "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).", + "description" : "The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store).", "type" : "string" } }, @@ -3721,11 +3721,11 @@ "additionalProperties" : false, "properties" : { "account" : { - "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", + "description" : "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.", "type" : "string" }, "amount" : { - "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.", + "description" : "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.", "$ref" : "#/components/schemas/SplitAmount" }, "description" : { @@ -3733,11 +3733,11 @@ "type" : "string" }, "reference" : { - "description" : "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", + "description" : "Your unique reference for the part of the payment booked to the specified `account`.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.", "type" : "string" }, "type" : { - "description" : "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.", + "description" : "The part of the payment you want to book to the specified `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n* **BalanceAccount**: books part of the payment (specified in `amount`) to the specified `account`.\n* Transaction fees types that you can book to the specified `account`:\n * **AcquiringFees**: the aggregated amount of the interchange and scheme fees.\n * **PaymentFee**: the aggregated amount of all transaction fees.\n * **AdyenFees**: the aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**: the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n * **Interchange**: the fees paid to the issuer for each payment made with the card network.\n * **SchemeFee**: the fees paid to the card scheme for using their network. \n* **Remainder**: the amount left over after a currency conversion, booked to the specified `account`.\n* **VAT**: the value-added tax charged on the payment, booked to your platforms liable balance account.\n* **Commission**: your platform's commission (specified in `amount`) on the payment, booked to your liable balance account.\n* **Default**: in very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support.\n\nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.", "enum" : [ "AcquiringFees", "AdyenCommission", diff --git a/json/NotificationConfigurationService-v1.json b/json/NotificationConfigurationService-v1.json index f692c8f..4c844eb 100644 --- a/json/NotificationConfigurationService-v1.json +++ b/json/NotificationConfigurationService-v1.json @@ -9,7 +9,7 @@ "version" : "1", "x-publicVersion" : true, "title" : "Notification Configuration API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v1/createNotificationConfiguration\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v1/createNotificationConfiguration\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/NotificationConfigurationService-v2.json b/json/NotificationConfigurationService-v2.json index 176e40b..639521d 100644 --- a/json/NotificationConfigurationService-v2.json +++ b/json/NotificationConfigurationService-v2.json @@ -9,7 +9,7 @@ "version" : "2", "x-publicVersion" : true, "title" : "Notification Configuration API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v2/createNotificationConfiguration\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v2/createNotificationConfiguration\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/NotificationConfigurationService-v3.json b/json/NotificationConfigurationService-v3.json index 740eaf7..dae4447 100644 --- a/json/NotificationConfigurationService-v3.json +++ b/json/NotificationConfigurationService-v3.json @@ -9,7 +9,7 @@ "version" : "3", "x-publicVersion" : true, "title" : "Notification Configuration API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v3/createNotificationConfiguration\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v3/createNotificationConfiguration\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/NotificationConfigurationService-v4.json b/json/NotificationConfigurationService-v4.json index cd25bb3..d11acd9 100644 --- a/json/NotificationConfigurationService-v4.json +++ b/json/NotificationConfigurationService-v4.json @@ -9,7 +9,7 @@ "version" : "4", "x-publicVersion" : true, "title" : "Notification Configuration API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v4/createNotificationConfiguration\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v4/createNotificationConfiguration\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/NotificationConfigurationService-v5.json b/json/NotificationConfigurationService-v5.json index f36be14..bd31000 100644 --- a/json/NotificationConfigurationService-v5.json +++ b/json/NotificationConfigurationService-v5.json @@ -9,7 +9,7 @@ "version" : "5", "x-publicVersion" : true, "title" : "Notification Configuration API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v5/createNotificationConfiguration\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v5/createNotificationConfiguration\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/NotificationConfigurationService-v6.json b/json/NotificationConfigurationService-v6.json index d55a8a8..19c4012 100644 --- a/json/NotificationConfigurationService-v6.json +++ b/json/NotificationConfigurationService-v6.json @@ -9,7 +9,7 @@ "version" : "6", "x-publicVersion" : true, "title" : "Notification Configuration API", - "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration\n```", + "description" : "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model) instead.\n\nThe Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Notification Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Notification/v6/createNotificationConfiguration\n```", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml index 56dc5b5..ba70977 100644 --- a/yaml/AccountService-v3.yaml +++ b/yaml/AccountService-v3.yaml @@ -6,12 +6,12 @@ info: x-publicVersion: true title: Account API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Account API provides endpoints for managing account-related\ \ entities on your platform. These related entities include account holders, accounts,\ \ bank accounts, shareholders, and verification-related documents. The management\ \ operations include actions such as creation, retrieval, updating, and deletion\ - \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n\ + \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ @@ -110,7 +110,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), @@ -185,7 +185,7 @@ paths: - Accounts summary: Create an account description: Creates an account under an account holder. An account holder can - have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-sortIndex: 1 x-methodName: createAccount @@ -255,10 +255,10 @@ paths: tags: - Account holders summary: Create an account holder - description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) + description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-sortIndex: 1 x-methodName: createAccountHolder @@ -701,7 +701,7 @@ paths: - Account holders summary: Get a tax form description: Generates a tax form for account holders operating in the US. For - more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms). operationId: post-getTaxForm x-sortIndex: 8 x-methodName: getTaxForm @@ -765,7 +765,7 @@ paths: - Verification summary: Get documents description: 'Returns documents that were previously uploaded for an account - holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). ' operationId: post-getUploadedDocuments @@ -830,7 +830,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. operationId: post-suspendAccountHolder x-sortIndex: 5 @@ -901,7 +901,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)\ + description: "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses)\ \ from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended**\ \ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)\ \ if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder)\ @@ -1208,7 +1208,7 @@ paths: - Verification summary: Upload a document description: Uploads a document for an account holder. Adyen uses the documents - during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). operationId: post-uploadDocument x-sortIndex: 1 x-methodName: uploadDocument @@ -1301,7 +1301,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -1327,7 +1327,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetailWrapper' type: array @@ -1501,7 +1501,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1512,7 +1512,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1545,14 +1545,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1560,7 +1560,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1568,7 +1568,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1582,14 +1582,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1598,7 +1598,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1614,13 +1614,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1630,7 +1630,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1643,13 +1643,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1659,25 +1659,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1687,7 +1687,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1696,7 +1696,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1723,7 +1723,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContactWrapper' type: array @@ -1854,7 +1854,7 @@ components: type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -2064,7 +2064,7 @@ components: bankAccountUUID: x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) - to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) + to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. >Required if the `documentType` is **BANK_STATEMENT**, where a document @@ -2076,7 +2076,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats. @@ -2130,7 +2130,7 @@ components: shareholderCode: x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) - to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted. >Required if the account holder has a `legalEntity` of type **Business** @@ -3282,7 +3282,7 @@ components: description: 'The content of the document, in Base64-encoded string format. - To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).' format: byte type: string documentDetail: diff --git a/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index 8440d8c..d4dd0e3 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -6,12 +6,12 @@ info: x-publicVersion: true title: Account API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Account API provides endpoints for managing account-related\ \ entities on your platform. These related entities include account holders, accounts,\ \ bank accounts, shareholders, and verification-related documents. The management\ \ operations include actions such as creation, retrieval, updating, and deletion\ - \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n\ + \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ @@ -110,7 +110,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), @@ -185,7 +185,7 @@ paths: - Accounts summary: Create an account description: Creates an account under an account holder. An account holder can - have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-sortIndex: 1 x-methodName: createAccount @@ -255,10 +255,10 @@ paths: tags: - Account holders summary: Create an account holder - description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) + description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-sortIndex: 1 x-methodName: createAccountHolder @@ -690,7 +690,7 @@ paths: - Account holders summary: Get a tax form description: Generates a tax form for account holders operating in the US. For - more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms). operationId: post-getTaxForm x-sortIndex: 8 x-methodName: getTaxForm @@ -754,7 +754,7 @@ paths: - Verification summary: Get documents description: 'Returns documents that were previously uploaded for an account - holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). ' operationId: post-getUploadedDocuments @@ -819,7 +819,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. operationId: post-suspendAccountHolder x-sortIndex: 5 @@ -890,7 +890,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)\ + description: "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses)\ \ from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended**\ \ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)\ \ if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder)\ @@ -1206,7 +1206,7 @@ paths: - Verification summary: Upload a document description: Uploads a document for an account holder. Adyen uses the documents - during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). operationId: post-uploadDocument x-sortIndex: 1 x-methodName: uploadDocument @@ -1308,7 +1308,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -1334,7 +1334,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetailWrapper' type: array @@ -1508,7 +1508,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1519,7 +1519,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1552,14 +1552,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1567,7 +1567,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1575,7 +1575,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1589,14 +1589,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1605,7 +1605,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1621,13 +1621,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1637,7 +1637,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1650,13 +1650,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1666,25 +1666,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1694,7 +1694,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1703,7 +1703,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1734,7 +1734,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContactWrapper' type: array @@ -1877,7 +1877,7 @@ components: type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -2109,7 +2109,7 @@ components: bankAccountUUID: x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) - to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) + to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. >Required if the `documentType` is **BANK_STATEMENT**, where a document @@ -2121,7 +2121,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats. @@ -2175,7 +2175,7 @@ components: shareholderCode: x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) - to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted. >Required if the account holder has a `legalEntity` of type **Business** @@ -3377,7 +3377,7 @@ components: description: 'The content of the document, in Base64-encoded string format. - To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).' format: byte type: string documentDetail: diff --git a/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index 422d62b..bc8aeb9 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -6,12 +6,12 @@ info: x-publicVersion: true title: Account API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Account API provides endpoints for managing account-related\ \ entities on your platform. These related entities include account holders, accounts,\ \ bank accounts, shareholders, and verification-related documents. The management\ \ operations include actions such as creation, retrieval, updating, and deletion\ - \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n\ + \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ @@ -182,7 +182,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), @@ -318,7 +318,7 @@ paths: - Accounts summary: Create an account description: Creates an account under an account holder. An account holder can - have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-sortIndex: 1 x-methodName: createAccount @@ -388,10 +388,10 @@ paths: tags: - Account holders summary: Create an account holder - description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) + description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-sortIndex: 1 x-methodName: createAccountHolder @@ -894,7 +894,7 @@ paths: - Account holders summary: Get a tax form description: Generates a tax form for account holders operating in the US. For - more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms). operationId: post-getTaxForm x-sortIndex: 8 x-methodName: getTaxForm @@ -958,7 +958,7 @@ paths: - Verification summary: Get documents description: 'Returns documents that were previously uploaded for an account - holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). ' operationId: post-getUploadedDocuments @@ -1023,7 +1023,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. operationId: post-suspendAccountHolder x-sortIndex: 5 @@ -1094,7 +1094,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)\ + description: "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses)\ \ from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended**\ \ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)\ \ if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder)\ @@ -1410,7 +1410,7 @@ paths: - Verification summary: Upload a document description: Uploads a document for an account holder. Adyen uses the documents - during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). operationId: post-uploadDocument x-sortIndex: 1 x-methodName: uploadDocument @@ -1547,7 +1547,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -1569,7 +1569,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetail' type: array @@ -1629,7 +1629,7 @@ components: x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer - to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards). + to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards). items: $ref: '#/components/schemas/PayoutMethod' type: array @@ -1639,7 +1639,7 @@ components: storeDetails: x-addedInVersion: '5' description: Array of stores associated with the account holder. Required - when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos). + when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos). items: $ref: '#/components/schemas/StoreDetail' type: array @@ -1766,7 +1766,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1777,7 +1777,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1814,14 +1814,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1829,7 +1829,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1837,7 +1837,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1851,14 +1851,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1867,7 +1867,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1883,13 +1883,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1899,7 +1899,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1912,13 +1912,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1928,25 +1928,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1956,7 +1956,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1965,7 +1965,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1992,7 +1992,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContact' type: array @@ -2146,7 +2146,7 @@ components: type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -2452,7 +2452,7 @@ components: bankAccountUUID: x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) - to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) + to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. >Required if the `documentType` is **BANK_STATEMENT**, where a document @@ -2464,7 +2464,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats. @@ -2520,7 +2520,7 @@ components: shareholderCode: x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) - to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted. >Required if the account holder has a `legalEntity` of type **Business** @@ -3035,7 +3035,7 @@ components: kycCheckCode: x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification - codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes). + codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes). format: int32 type: integer kycCheckDescription: @@ -3199,7 +3199,7 @@ components: merchantAccount: description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string payoutMethodCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the @@ -3213,12 +3213,12 @@ components: recurringDetailReference: description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card - details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string shopperReference: description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string required: - merchantAccount @@ -3989,7 +3989,7 @@ components: description: 'The content of the document, in Base64-encoded string format. - To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).' format: byte type: string documentDetail: diff --git a/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index 69ff0bc..ce1719f 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -6,12 +6,12 @@ info: x-publicVersion: true title: Account API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Account API provides endpoints for managing account-related\ \ entities on your platform. These related entities include account holders, accounts,\ \ bank accounts, shareholders, and verification-related documents. The management\ \ operations include actions such as creation, retrieval, updating, and deletion\ - \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n\ + \ of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ @@ -182,7 +182,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), @@ -318,7 +318,7 @@ paths: - Accounts summary: Create an account description: Creates an account under an account holder. An account holder can - have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-sortIndex: 1 x-methodName: createAccount @@ -388,10 +388,10 @@ paths: tags: - Account holders summary: Create an account holder - description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) + description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/classic-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/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-sortIndex: 1 x-methodName: createAccountHolder @@ -894,7 +894,7 @@ paths: - Account holders summary: Get a tax form description: Generates a tax form for account holders operating in the US. For - more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/classic-platforms/tax-forms). operationId: post-getTaxForm x-sortIndex: 8 x-methodName: getTaxForm @@ -958,7 +958,7 @@ paths: - Verification summary: Get documents description: 'Returns documents that were previously uploaded for an account - holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). ' operationId: post-getUploadedDocuments @@ -1023,7 +1023,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) + description: Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**. operationId: post-suspendAccountHolder x-sortIndex: 5 @@ -1094,7 +1094,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses)\ + description: "Changes the [status of an account holder](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#account-holder-statuses)\ \ from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended**\ \ [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)\ \ if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder)\ @@ -1410,7 +1410,7 @@ paths: - Verification summary: Upload a document description: Uploads a document for an account holder. Adyen uses the documents - during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). + during the [verification process](https://docs.adyen.com/classic-platforms/verification-process). operationId: post-uploadDocument x-sortIndex: 1 x-methodName: uploadDocument @@ -1547,7 +1547,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -1569,7 +1569,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetail' type: array @@ -1607,7 +1607,7 @@ components: legalArrangements: x-addedInVersion: '6' description: An array containing information about the account holder's - [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements). + [legal arrangements](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements). items: $ref: '#/components/schemas/LegalArrangementDetail' type: array @@ -1636,7 +1636,7 @@ components: x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer - to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards). + to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards). items: $ref: '#/components/schemas/PayoutMethod' type: array @@ -1646,7 +1646,7 @@ components: storeDetails: x-addedInVersion: '5' description: Array of stores associated with the account holder. Required - when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos). + when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos). items: $ref: '#/components/schemas/StoreDetail' type: array @@ -1773,7 +1773,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1784,7 +1784,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1821,14 +1821,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1836,7 +1836,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1844,7 +1844,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1858,14 +1858,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1874,7 +1874,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1890,13 +1890,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1906,7 +1906,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1919,13 +1919,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1935,25 +1935,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1963,7 +1963,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1972,7 +1972,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1999,7 +1999,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContact' type: array @@ -2167,7 +2167,7 @@ components: type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/classic-platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -2483,7 +2483,7 @@ components: bankAccountUUID: x-addedInVersion: '2' description: 'The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) - to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) + to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/classic-platforms/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted. >Required if the `documentType` is **BANK_STATEMENT**, where a document @@ -2495,7 +2495,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats. @@ -2562,7 +2562,7 @@ components: shareholderCode: x-addedInVersion: '2' description: 'The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) - to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) + to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks) for details on when a document should be submitted. >Required if the account holder has a `legalEntity` of type **Business** @@ -3059,7 +3059,7 @@ components: kycCheckCode: x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification - codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes). + codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes). format: int32 type: integer kycCheckDescription: @@ -3268,7 +3268,7 @@ components: description: The tax identification number of the legal arrangement. type: string type: - description: "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\ + description: "The [type of legal arrangement](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements#types-of-legal-arrangements).\n\ \nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship**\ \ \n\n- **Trust** \n\n" enum: @@ -3468,7 +3468,7 @@ components: merchantAccount: description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string payoutMethodCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the @@ -3482,12 +3482,12 @@ components: recurringDetailReference: description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card - details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string shopperReference: description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string required: - merchantAccount @@ -4270,7 +4270,7 @@ components: description: 'The content of the document, in Base64-encoded string format. - To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-checks).' format: byte type: string documentDetail: diff --git a/yaml/FundService-v3.yaml b/yaml/FundService-v3.yaml index 5af9a12..7db4139 100644 --- a/yaml/FundService-v3.yaml +++ b/yaml/FundService-v3.yaml @@ -6,20 +6,20 @@ info: x-publicVersion: true title: Fund API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts\ \ on your platform. These management operations include, for example, the transfer\ \ of funds from one account to another, the payout of funds to an account holder,\ \ and the retrieval of balances in an account.\n\nFor more information, refer\ - \ to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n\ - ## Authentication\nYour Adyen contact will provide your API credential and an\ - \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ - \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ - \ \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use\ - \ the username and password to connect to the API using basic authentication.\ - \ For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you\ - \ need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ + \ to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\n\ + Your Adyen contact will provide your API credential and an API key. To connect\ + \ to the API, add an `X-API-Key` header with the API key as the value, for example:\n\ + \n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\"\ + :\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\ + When going live, you need to generate new web service user credentials to access\ + \ the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ \n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ \ using a version suffix in the endpoint URL. This suffix has the following format:\ \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v3/accountHolderBalance\n\ @@ -179,7 +179,7 @@ paths: \ specified in the split instructions. Adyen sends the result of the direct\ \ debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED)\ \ notification webhook.\n\n To learn more about direct debits, see [Top up\ - \ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)." + \ accounts](https://docs.adyen.com/classic-platforms/top-up-accounts)." operationId: post-debitAccountHolder x-sortIndex: 8 x-methodName: debitAccountHolder @@ -823,7 +823,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -834,7 +834,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -867,14 +867,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -882,7 +882,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -890,7 +890,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -904,14 +904,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -920,7 +920,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -936,13 +936,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -952,7 +952,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -965,13 +965,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -981,25 +981,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1009,7 +1009,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1018,7 +1018,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1335,11 +1335,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -1347,21 +1347,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -1369,18 +1370,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml index 6daa1e4..75280e5 100644 --- a/yaml/FundService-v5.yaml +++ b/yaml/FundService-v5.yaml @@ -6,20 +6,20 @@ info: x-publicVersion: true title: Fund API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts\ \ on your platform. These management operations include, for example, the transfer\ \ of funds from one account to another, the payout of funds to an account holder,\ \ and the retrieval of balances in an account.\n\nFor more information, refer\ - \ to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n\ - ## Authentication\nYour Adyen contact will provide your API credential and an\ - \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ - \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ - \ \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use\ - \ the username and password to connect to the API using basic authentication.\ - \ For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you\ - \ need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ + \ to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\n\ + Your Adyen contact will provide your API credential and an API key. To connect\ + \ to the API, add an `X-API-Key` header with the API key as the value, for example:\n\ + \n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\"\ + :\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\ + When going live, you need to generate new web service user credentials to access\ + \ the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ \n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ \ using a version suffix in the endpoint URL. This suffix has the following format:\ \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v5/accountHolderBalance\n\ @@ -179,7 +179,7 @@ paths: \ specified in the split instructions. Adyen sends the result of the direct\ \ debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED)\ \ notification webhook.\n\n To learn more about direct debits, see [Top up\ - \ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)." + \ accounts](https://docs.adyen.com/classic-platforms/top-up-accounts)." operationId: post-debitAccountHolder x-sortIndex: 8 x-methodName: debitAccountHolder @@ -803,7 +803,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -814,7 +814,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -851,14 +851,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -866,7 +866,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -874,7 +874,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -888,14 +888,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -904,7 +904,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -920,13 +920,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -936,7 +936,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -949,13 +949,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -965,25 +965,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -993,7 +993,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1002,7 +1002,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1524,11 +1524,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -1536,21 +1536,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -1558,18 +1559,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/FundService-v6.yaml b/yaml/FundService-v6.yaml index cd46b5d..2ef8756 100644 --- a/yaml/FundService-v6.yaml +++ b/yaml/FundService-v6.yaml @@ -6,20 +6,20 @@ info: x-publicVersion: true title: Fund API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Fund API provides endpoints for managing the funds in the accounts\ \ on your platform. These management operations include, for example, the transfer\ \ of funds from one account to another, the payout of funds to an account holder,\ \ and the retrieval of balances in an account.\n\nFor more information, refer\ - \ to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/).\n\ - ## Authentication\nYour Adyen contact will provide your API credential and an\ - \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ - \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ - \ \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use\ - \ the username and password to connect to the API using basic authentication.\ - \ For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you\ - \ need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ + \ to our [documentation](https://docs.adyen.com/classic-platforms).\n## Authentication\n\ + Your Adyen contact will provide your API credential and an API key. To connect\ + \ to the API, add an `X-API-Key` header with the API key as the value, for example:\n\ + \n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\ + \ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\ + \ to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\"\ + :\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\ + When going live, you need to generate new web service user credentials to access\ + \ the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\ \n## Versioning\nThe Fund API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ \ using a version suffix in the endpoint URL. This suffix has the following format:\ \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance\n\ @@ -179,7 +179,7 @@ paths: \ specified in the split instructions. Adyen sends the result of the direct\ \ debit in a [`DIRECT_DEBIT_INITIATED`](https://docs.adyen.com/api-explorer/#/NotificationService/latest/post/DIRECT_DEBIT_INITIATED)\ \ notification webhook.\n\n To learn more about direct debits, see [Top up\ - \ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)." + \ accounts](https://docs.adyen.com/classic-platforms/top-up-accounts)." operationId: post-debitAccountHolder x-sortIndex: 8 x-methodName: debitAccountHolder @@ -803,7 +803,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -814,7 +814,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -851,14 +851,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -866,7 +866,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -874,7 +874,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -888,14 +888,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -904,7 +904,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -920,13 +920,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -936,7 +936,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -949,13 +949,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -965,25 +965,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -993,7 +993,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1002,7 +1002,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1524,11 +1524,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -1536,21 +1536,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -1558,18 +1559,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/HopService-v1.yaml b/yaml/HopService-v1.yaml index d3e26ee..91beb9a 100644 --- a/yaml/HopService-v1.yaml +++ b/yaml/HopService-v1.yaml @@ -6,10 +6,10 @@ info: x-publicVersion: true title: Hosted onboarding API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Hosted onboarding API provides endpoints that you can use to\ - \ generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page)\ - \ or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).\ + \ generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page)\ + \ or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners).\ \ You can provide these links to your account holders so that they can complete\ \ their onboarding.\n\n## Authentication\nYour Adyen contact will provide your\ \ API credential and an API key. To connect to the API, add an `X-API-Key` header\ @@ -38,7 +38,7 @@ paths: summary: Get a link to a Adyen-hosted onboarding page description: 'Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer - to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ' + to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-sortIndex: 1 x-methodName: getOnboardingUrl @@ -100,7 +100,7 @@ paths: summary: Get a link to a PCI compliance questionnaire description: "Returns a link to a PCI compliance questionnaire that you can\ \ send to your account holder.\n > You should only use this endpoint if you\ - \ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)." + \ have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-sortIndex: 1 x-methodName: getPciQuestionnaireUrl @@ -161,27 +161,27 @@ components: additionalProperties: false properties: bankDetails: - description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) + description: Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**. type: boolean businessDetails: - description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) + description: Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**. type: boolean individualDetails: - description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) + description: Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**. type: boolean legalArrangementDetails: - description: Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) + description: Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**. type: boolean pciQuestionnaire: - description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) + description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**. type: boolean shareholderDetails: - description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) + description: Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**. type: boolean type: object @@ -386,9 +386,9 @@ components: type: string collectInformation: description: Contains indicators whether the page should only collect information - for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). + for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply - to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks @@ -414,7 +414,7 @@ components: \ in the request or if the language is not supported, the page uses the\ \ browser language. If the browser language is not supported, the page\ \ uses **en-US** by default.\n\nFor a list of supported languages, refer\ - \ to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language)." + \ to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language)." type: string showPages: description: Contains indicators whether specific pages must be shown to diff --git a/yaml/HopService-v5.yaml b/yaml/HopService-v5.yaml index e9d21ef..14eadc2 100644 --- a/yaml/HopService-v5.yaml +++ b/yaml/HopService-v5.yaml @@ -6,10 +6,10 @@ info: x-publicVersion: true title: Hosted onboarding API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Hosted onboarding API provides endpoints that you can use to\ - \ generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page)\ - \ or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).\ + \ generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page)\ + \ or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners).\ \ You can provide these links to your account holders so that they can complete\ \ their onboarding.\n\n## Authentication\nYour Adyen contact will provide your\ \ API credential and an API key. To connect to the API, add an `X-API-Key` header\ @@ -38,7 +38,7 @@ paths: summary: Get a link to a Adyen-hosted onboarding page description: 'Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer - to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ' + to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-sortIndex: 1 x-methodName: getOnboardingUrl @@ -100,7 +100,7 @@ paths: summary: Get a link to a PCI compliance questionnaire description: "Returns a link to a PCI compliance questionnaire that you can\ \ send to your account holder.\n > You should only use this endpoint if you\ - \ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)." + \ have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-sortIndex: 1 x-methodName: getPciQuestionnaireUrl @@ -161,27 +161,27 @@ components: additionalProperties: false properties: bankDetails: - description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) + description: Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**. type: boolean businessDetails: - description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) + description: Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**. type: boolean individualDetails: - description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) + description: Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**. type: boolean legalArrangementDetails: - description: Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) + description: Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**. type: boolean pciQuestionnaire: - description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) + description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**. type: boolean shareholderDetails: - description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) + description: Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**. type: boolean type: object @@ -386,9 +386,9 @@ components: type: string collectInformation: description: Contains indicators whether the page should only collect information - for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). + for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply - to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks @@ -414,7 +414,7 @@ components: \ in the request or if the language is not supported, the page uses the\ \ browser language. If the browser language is not supported, the page\ \ uses **en-US** by default.\n\nFor a list of supported languages, refer\ - \ to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language)." + \ to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language)." type: string showPages: description: Contains indicators whether specific pages must be shown to diff --git a/yaml/HopService-v6.yaml b/yaml/HopService-v6.yaml index a26541b..ea93f3b 100644 --- a/yaml/HopService-v6.yaml +++ b/yaml/HopService-v6.yaml @@ -6,10 +6,10 @@ info: x-publicVersion: true title: Hosted onboarding API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Hosted onboarding API provides endpoints that you can use to\ - \ generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page)\ - \ or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners).\ + \ generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/classic-platforms/hosted-onboarding-page)\ + \ or a [PCI compliance questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners).\ \ You can provide these links to your account holders so that they can complete\ \ their onboarding.\n\n## Authentication\nYour Adyen contact will provide your\ \ API credential and an API key. To connect to the API, add an `X-API-Key` header\ @@ -38,7 +38,7 @@ paths: summary: Get a link to a Adyen-hosted onboarding page description: 'Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer - to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ' + to [Hosted onboarding](https://docs.adyen.com/classic-platforms/collect-verification-details/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-sortIndex: 1 x-methodName: getOnboardingUrl @@ -100,7 +100,7 @@ paths: summary: Get a link to a PCI compliance questionnaire description: "Returns a link to a PCI compliance questionnaire that you can\ \ send to your account holder.\n > You should only use this endpoint if you\ - \ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)." + \ have a [partner platform setup](https://docs.adyen.com/classic-platforms/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-sortIndex: 1 x-methodName: getPciQuestionnaireUrl @@ -161,27 +161,27 @@ components: additionalProperties: false properties: bankDetails: - description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#bank-accounts) + description: Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**. type: boolean businessDetails: - description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#organizations) + description: Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**. type: boolean individualDetails: - description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) + description: Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**. type: boolean legalArrangementDetails: - description: Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/legal-arrangements) + description: Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**. type: boolean pciQuestionnaire: - description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#onboard-partner-platform) + description: Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**. type: boolean shareholderDetails: - description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/accepted-data-format/#individuals) + description: Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**. type: boolean type: object @@ -386,9 +386,9 @@ components: type: string collectInformation: description: Contains indicators whether the page should only collect information - for specific [KYC checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks). + for specific [KYC checks](https://docs.adyen.com/classic-platforms/verification-checks). By default, the page collects information for all KYC checks that apply - to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). + to the [legal entity type](https://docs.adyen.com/classic-platforms/account-holders-and-accounts#legal-entity-types). $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks @@ -414,7 +414,7 @@ components: \ in the request or if the language is not supported, the page uses the\ \ browser language. If the browser language is not supported, the page\ \ uses **en-US** by default.\n\nFor a list of supported languages, refer\ - \ to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language)." + \ to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language)." type: string showPages: description: Contains indicators whether specific pages must be shown to diff --git a/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml index a2e4516..9aa2724 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -4,11 +4,11 @@ info: x-publicVersion: true title: Classic Platforms - Notifications description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification API sends notifications to the endpoints specified\ \ in a given subscription. \nSubscriptions are managed through the Notification\ \ Configuration API. The API specifications listed here detail the format of each\ - \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications)." + \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications)." termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -398,7 +398,7 @@ webhooks: tags: - Other summary: Booking for a capture or refund failed - description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) + description: Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified @@ -595,7 +595,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -699,7 +699,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetailWrapper' type: array @@ -1214,7 +1214,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1225,7 +1225,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1258,14 +1258,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1273,7 +1273,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1281,7 +1281,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1295,14 +1295,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1311,7 +1311,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1327,13 +1327,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1343,7 +1343,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1356,13 +1356,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1372,25 +1372,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1400,7 +1400,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1409,7 +1409,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1493,7 +1493,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContactWrapper' type: array @@ -2578,11 +2578,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -2590,21 +2590,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -2612,18 +2613,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index aac4f82..3dd2f86 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -4,11 +4,11 @@ info: x-publicVersion: true title: Classic Platforms - Notifications description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification API sends notifications to the endpoints specified\ \ in a given subscription. \nSubscriptions are managed through the Notification\ \ Configuration API. The API specifications listed here detail the format of each\ - \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications)." + \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications)." termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -398,7 +398,7 @@ webhooks: tags: - Other summary: Booking for a capture or refund failed - description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) + description: Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified @@ -607,7 +607,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -723,7 +723,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetailWrapper' type: array @@ -1278,7 +1278,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1289,7 +1289,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1322,14 +1322,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1337,7 +1337,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1345,7 +1345,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1359,14 +1359,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1375,7 +1375,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1391,13 +1391,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1407,7 +1407,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1420,13 +1420,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1436,25 +1436,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1464,7 +1464,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1473,7 +1473,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1567,7 +1567,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContactWrapper' type: array @@ -2693,11 +2693,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -2705,21 +2705,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -2727,18 +2728,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index 7b0a2b0..c105cd1 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -4,11 +4,11 @@ info: x-publicVersion: true title: Classic Platforms - Notifications description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification API sends notifications to the endpoints specified\ \ in a given subscription. \nSubscriptions are managed through the Notification\ \ Configuration API. The API specifications listed here detail the format of each\ - \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications)." + \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications)." termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -402,7 +402,7 @@ webhooks: tags: - Other summary: Booking for a capture or refund failed - description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) + description: Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified @@ -624,7 +624,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -746,7 +746,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetail' type: array @@ -806,7 +806,7 @@ components: x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer - to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards). + to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards). items: $ref: '#/components/schemas/PayoutMethod' type: array @@ -816,7 +816,7 @@ components: storeDetails: x-addedInVersion: '5' description: Array of stores associated with the account holder. Required - when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos). + when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos). items: $ref: '#/components/schemas/StoreDetail' type: array @@ -1413,7 +1413,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1424,7 +1424,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1461,14 +1461,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1476,7 +1476,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1484,7 +1484,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1498,14 +1498,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1514,7 +1514,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1530,13 +1530,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1546,7 +1546,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1559,13 +1559,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1575,25 +1575,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1603,7 +1603,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1612,7 +1612,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1710,7 +1710,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContact' type: array @@ -2310,7 +2310,7 @@ components: kycCheckCode: x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification - codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes). + codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes). format: int32 type: integer kycCheckDescription: @@ -2487,7 +2487,7 @@ components: merchantAccount: description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string payoutMethodCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the @@ -2501,12 +2501,12 @@ components: recurringDetailReference: description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card - details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string shopperReference: description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string required: - merchantAccount @@ -2935,11 +2935,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -2947,21 +2947,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -2969,18 +2970,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index d83ff22..cca610c 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -4,11 +4,11 @@ info: x-publicVersion: true title: Classic Platforms - Notifications description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification API sends notifications to the endpoints specified\ \ in a given subscription. \nSubscriptions are managed through the Notification\ \ Configuration API. The API specifications listed here detail the format of each\ - \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications)." + \ notification.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications)." termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -402,7 +402,7 @@ webhooks: tags: - Other summary: Booking for a capture or refund failed - description: Adyen sends this notification when a [split payment](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information) + description: Adyen sends this notification when a [split payment](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information) booking for a capture or refund fails. When a booking fails due to an invalid account status or an unknown `accountCode`, the funds are credited or debited to or fromyour platform's liable account instead of the account specified @@ -624,7 +624,7 @@ components: >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).' + For more information, refer to [Verification checks](https://docs.adyen.com/classic-platforms/verification-process).' enum: - InactivateAccount - RefundNotPaidOutTransfers @@ -746,7 +746,7 @@ components: bankAccountDetails: description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required - information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information). + information](https://docs.adyen.com/classic-platforms/verification-process/required-information). items: $ref: '#/components/schemas/BankAccountDetail' type: array @@ -784,7 +784,7 @@ components: legalArrangements: x-addedInVersion: '6' description: An array containing information about the account holder's - [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements). + [legal arrangements](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements). items: $ref: '#/components/schemas/LegalArrangementDetail' type: array @@ -813,7 +813,7 @@ components: x-addedInVersion: '5' description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer - to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards). + to [Pay out to cards](https://docs.adyen.com/classic-platforms/payout-to-cards). items: $ref: '#/components/schemas/PayoutMethod' type: array @@ -823,7 +823,7 @@ components: storeDetails: x-addedInVersion: '5' description: Array of stores associated with the account holder. Required - when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos). + when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/classic-platforms/platforms-for-pos). items: $ref: '#/components/schemas/StoreDetail' type: array @@ -1452,7 +1452,7 @@ components: accountNumber: description: 'The bank account number (without separators). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string accountType: @@ -1463,7 +1463,7 @@ components: The permitted values are: `checking`, `savings`. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankAccountName: @@ -1500,14 +1500,14 @@ components: bankBicSwift: description: 'The bank identifier code. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCity: description: 'The city in which the bank branch is located. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankCode: @@ -1515,7 +1515,7 @@ components: account is registered. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string bankName: @@ -1523,7 +1523,7 @@ components: is held. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string branchCode: @@ -1537,14 +1537,14 @@ components: * Germany - Bankleitzahl - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string checkCode: description: 'The check code of the bank account. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string countryCode: @@ -1553,7 +1553,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string currencyCode: @@ -1569,13 +1569,13 @@ components: >The IBAN standard is defined in ISO-13616. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCity: description: 'The city of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerCountryCode: @@ -1585,7 +1585,7 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerDateOfBirth: @@ -1598,13 +1598,13 @@ components: description: 'The house name or number of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerName: description: 'The name of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerNationality: @@ -1614,25 +1614,25 @@ components: >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL''). - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerPostalCode: description: 'The postal code of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerState: description: 'The state of residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string ownerStreet: description: 'The street name of the residence of the bank account owner. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string primaryAccount: @@ -1642,7 +1642,7 @@ components: description: 'The tax ID number. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string urlForVerification: @@ -1651,7 +1651,7 @@ components: This may be generated on bank account creation. - >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) + >Refer to [Required information](https://docs.adyen.com/classic-platforms/verification-process/required-information) for details on field requirements.' type: string type: object @@ -1749,7 +1749,7 @@ components: shareholders: description: Array containing information about individuals associated with the account holder either through ownership or control. For details about - how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos). + how you can identify them, refer to [our verification guide](https://docs.adyen.com/classic-platforms/verification-process#identify-ubos). items: $ref: '#/components/schemas/ShareholderContact' type: array @@ -2343,7 +2343,7 @@ components: kycCheckCode: x-addedInVersion: '5' description: The code of the check. For possible values, refer to [Verification - codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes). + codes](https://docs.adyen.com/classic-platforms/verification-process/verification-codes). format: int32 type: integer kycCheckDescription: @@ -2552,7 +2552,7 @@ components: description: The tax identification number of the legal arrangement. type: string type: - description: "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\ + description: "The [type of legal arrangement](https://docs.adyen.com/classic-platforms/verification-process/legal-arrangements#types-of-legal-arrangements).\n\ \nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship**\ \ \n\n- **Trust** \n\n" enum: @@ -2765,7 +2765,7 @@ components: merchantAccount: description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string payoutMethodCode: description: Adyen-generated unique alphanumeric identifier (UUID) for the @@ -2779,12 +2779,12 @@ components: recurringDetailReference: description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned in the `/payments` response when you [saved the account holder's card - details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string shopperReference: description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's - card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store). + card details](https://docs.adyen.com/classic-platforms/payouts/manual-payout/payout-to-cards#check-and-store). type: string required: - merchantAccount @@ -3213,11 +3213,11 @@ components: is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): + * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): + * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string @@ -3225,21 +3225,22 @@ components: description: 'The amount of the split item. - * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). + * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, - or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) + or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: - description: 'Your unique reference for the split item. + description: 'Your unique reference for the part of the payment booked to + the specified `account`. - This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) - or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). + This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) + or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference @@ -3247,18 +3248,29 @@ components: overview and in the reports.' type: string type: - description: 'The type of the split item. - - - Possible values: - - - * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): - **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. - - * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): - **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, - **Surcharge**, **Tip**, **VAT**.' + description: "The part of the payment you want to book to the specified\ + \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ + * **BalanceAccount**: books part of the payment (specified in `amount`)\ + \ to the specified `account`.\n* Transaction fees types that you can book\ + \ to the specified `account`:\n * **AcquiringFees**: the aggregated\ + \ amount of the interchange and scheme fees.\n * **PaymentFee**: the\ + \ aggregated amount of all transaction fees.\n * **AdyenFees**: the\ + \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ + \ the transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **AdyenMarkup**: the transaction fees due to Adyen under [Interchange\ + \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ + \ * **Interchange**: the fees paid to the issuer for each payment made\ + \ with the card network.\n * **SchemeFee**: the fees paid to the card\ + \ scheme for using their network. \n* **Remainder**: the amount left over\ + \ after a currency conversion, booked to the specified `account`.\n* **VAT**:\ + \ the value-added tax charged on the payment, booked to your platforms\ + \ liable balance account.\n* **Commission**: your platform's commission\ + \ (specified in `amount`) on the payment, booked to your liable balance\ + \ account.\n* **Default**: in very specific use cases, allows you to book\ + \ the specified `amount` to the specified `account`. For more information,\ + \ contact Adyen support.\n\nPossible values for the [Classic Platforms\ + \ integration](https://docs.adyen.com/classic-platforms): **Commission**,\ + \ **Default**, **Marketplace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission diff --git a/yaml/NotificationConfigurationService-v1.yaml b/yaml/NotificationConfigurationService-v1.yaml index 1415f8d..775351d 100644 --- a/yaml/NotificationConfigurationService-v1.yaml +++ b/yaml/NotificationConfigurationService-v1.yaml @@ -6,11 +6,11 @@ info: x-publicVersion: true title: Notification Configuration API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification Configuration API provides endpoints for setting\ \ up and testing notifications that inform you of events on your platform, for\ \ example when a verification check or a payout has been completed.\n\nFor more\ - \ information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n\ + \ information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ diff --git a/yaml/NotificationConfigurationService-v2.yaml b/yaml/NotificationConfigurationService-v2.yaml index 6196132..ca953f6 100644 --- a/yaml/NotificationConfigurationService-v2.yaml +++ b/yaml/NotificationConfigurationService-v2.yaml @@ -6,11 +6,11 @@ info: x-publicVersion: true title: Notification Configuration API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification Configuration API provides endpoints for setting\ \ up and testing notifications that inform you of events on your platform, for\ \ example when a verification check or a payout has been completed.\n\nFor more\ - \ information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n\ + \ information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ diff --git a/yaml/NotificationConfigurationService-v3.yaml b/yaml/NotificationConfigurationService-v3.yaml index 3a0a2da..b90b59c 100644 --- a/yaml/NotificationConfigurationService-v3.yaml +++ b/yaml/NotificationConfigurationService-v3.yaml @@ -6,11 +6,11 @@ info: x-publicVersion: true title: Notification Configuration API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification Configuration API provides endpoints for setting\ \ up and testing notifications that inform you of events on your platform, for\ \ example when a verification check or a payout has been completed.\n\nFor more\ - \ information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n\ + \ information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ diff --git a/yaml/NotificationConfigurationService-v4.yaml b/yaml/NotificationConfigurationService-v4.yaml index 24ac1e5..ff81ee6 100644 --- a/yaml/NotificationConfigurationService-v4.yaml +++ b/yaml/NotificationConfigurationService-v4.yaml @@ -6,11 +6,11 @@ info: x-publicVersion: true title: Notification Configuration API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification Configuration API provides endpoints for setting\ \ up and testing notifications that inform you of events on your platform, for\ \ example when a verification check or a payout has been completed.\n\nFor more\ - \ information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n\ + \ information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ diff --git a/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml index 6819bc3..84131e0 100644 --- a/yaml/NotificationConfigurationService-v5.yaml +++ b/yaml/NotificationConfigurationService-v5.yaml @@ -6,11 +6,11 @@ info: x-publicVersion: true title: Notification Configuration API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification Configuration API provides endpoints for setting\ \ up and testing notifications that inform you of events on your platform, for\ \ example when a verification check or a payout has been completed.\n\nFor more\ - \ information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n\ + \ information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ diff --git a/yaml/NotificationConfigurationService-v6.yaml b/yaml/NotificationConfigurationService-v6.yaml index e9fae5d..80f64c4 100644 --- a/yaml/NotificationConfigurationService-v6.yaml +++ b/yaml/NotificationConfigurationService-v6.yaml @@ -6,11 +6,11 @@ info: x-publicVersion: true title: Notification Configuration API description: "This API is used for the classic integration. If you are just starting\ - \ your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms)\ + \ your implementation, refer to our [new integration guide](https://docs.adyen.com/adyen-for-platforms-model)\ \ instead.\n\nThe Notification Configuration API provides endpoints for setting\ \ up and testing notifications that inform you of events on your platform, for\ \ example when a verification check or a payout has been completed.\n\nFor more\ - \ information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic/notifications).\n\ + \ information, refer to our [documentation](https://docs.adyen.com/classic-platforms/notifications).\n\ ## Authentication\nYour Adyen contact will provide your API credential and an\ \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\