From e966881e67f82cec0cc5ac1dea4dbe50e22834d3 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Fri, 2 Sep 2022 09:06:05 +0000 Subject: [PATCH] spec release --- json/AccountService-v3.json | 336 +++++++++++++---- json/AccountService-v4.json | 338 +++++++++++++---- json/AccountService-v5.json | 350 ++++++++++++++---- json/AccountService-v6.json | 350 ++++++++++++++---- json/FundService-v3.json | 14 +- json/FundService-v5.json | 17 +- json/FundService-v6.json | 17 +- json/HopService-v1.json | 29 +- json/HopService-v5.json | 29 +- json/HopService-v6.json | 29 +- json/MarketPayNotificationService-v3.json | 27 +- json/MarketPayNotificationService-v4.json | 27 +- json/MarketPayNotificationService-v5.json | 39 +- json/MarketPayNotificationService-v6.json | 39 +- json/NotificationConfigurationService-v1.json | 6 +- json/NotificationConfigurationService-v2.json | 6 +- json/NotificationConfigurationService-v3.json | 6 +- json/NotificationConfigurationService-v4.json | 6 +- json/NotificationConfigurationService-v5.json | 9 +- json/NotificationConfigurationService-v6.json | 9 +- yaml/AccountService-v3.yaml | 249 +++++++++---- yaml/AccountService-v4.yaml | 251 +++++++++---- yaml/AccountService-v5.yaml | 261 +++++++++---- yaml/AccountService-v6.yaml | 261 +++++++++---- yaml/FundService-v3.yaml | 42 ++- yaml/FundService-v5.yaml | 45 ++- yaml/FundService-v6.yaml | 45 ++- yaml/HopService-v1.yaml | 39 +- yaml/HopService-v5.yaml | 39 +- yaml/HopService-v6.yaml | 39 +- yaml/MarketPayNotificationService-v3.yaml | 27 +- yaml/MarketPayNotificationService-v4.yaml | 27 +- yaml/MarketPayNotificationService-v5.yaml | 37 +- yaml/MarketPayNotificationService-v6.yaml | 37 +- yaml/NotificationConfigurationService-v1.yaml | 10 +- yaml/NotificationConfigurationService-v2.yaml | 10 +- yaml/NotificationConfigurationService-v3.yaml | 10 +- yaml/NotificationConfigurationService-v4.yaml | 10 +- yaml/NotificationConfigurationService-v5.yaml | 13 +- yaml/NotificationConfigurationService-v6.yaml | 13 +- 40 files changed, 2295 insertions(+), 853 deletions(-) diff --git a/json/AccountService-v3.json b/json/AccountService-v3.json index 9521741..d33447a 100644 --- a/json/AccountService-v3.json +++ b/json/AccountService-v3.json @@ -8,9 +8,9 @@ "info" : { "version" : "3", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Account API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-06T09:18:38Z", + "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```", + "x-timestamp" : "2022-08-29T12:22:33Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -159,7 +159,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](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/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.", "operationId" : "post-closeAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -277,7 +277,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/platforms/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/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -395,7 +395,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", + "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).", "operationId" : "post-createAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -644,6 +644,141 @@ } } }, + "/deleteLegalArrangements" : { + "post" : { + "tags" : [ + "Verification" + ], + "summary" : "Delete legal arrangements", + "description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.", + "operationId" : "post-deleteLegalArrangements", + "x-groupName" : "Verification", + "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities" + } + }, + "schema" : { + "$ref" : "#/components/schemas/DeleteLegalArrangementRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-200" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "Accepted - the request has been accepted for processing, but the processing has not been completed." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-400" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-400" + }, + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/deleteShareholders" : { "post" : { "tags" : [ @@ -653,7 +788,7 @@ "description" : "Deletes shareholders associated with an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", - "x-sortIndex" : 6, + "x-sortIndex" : 7, "security" : [ { "BasicAuth" : [ @@ -771,7 +906,7 @@ "description" : "Deletes signatories associated with an account holder.", "operationId" : "post-deleteSignatories", "x-groupName" : "Verification", - "x-sortIndex" : 7, + "x-sortIndex" : 8, "security" : [ { "BasicAuth" : [ @@ -1002,7 +1137,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/platforms/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/marketplaces-and-platforms/classic/tax-forms).", "operationId" : "post-getTaxForm", "x-groupName" : "Account holders", "x-sortIndex" : 8, @@ -1110,7 +1245,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/platforms/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/marketplaces-and-platforms/classic/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -1218,7 +1353,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "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**.", "operationId" : "post-suspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1336,7 +1471,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \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/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).", "operationId" : "post-unSuspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -1817,7 +1952,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/platforms/verification-process).", + "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).", "operationId" : "post-uploadDocument", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2386,7 +2521,7 @@ }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" } @@ -2459,29 +2594,15 @@ "description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" }, @@ -2557,6 +2678,25 @@ "bankAccountUUIDs" ] }, + "DeleteLegalArrangementRequest" : { + "properties" : { + "accountHolderCode" : { + "description" : "The code of the account holder.", + "type" : "string" + }, + "legalArrangements" : { + "description" : "List of legal arrangements.", + "items" : { + "$ref" : "#/components/schemas/LegalArrangementRequest" + }, + "type" : "array" + } + }, + "required" : [ + "accountHolderCode", + "legalArrangements" + ] + }, "DeleteShareholderRequest" : { "properties" : { "accountHolderCode" : { @@ -2604,7 +2744,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/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", + "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", "type" : "string" }, "description" : { @@ -2612,7 +2752,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/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", + "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", "enum" : [ "BANK_STATEMENT", "BSN", @@ -2634,7 +2774,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/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**. ", + "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**. ", "type" : "string" }, "signatoryCode" : { @@ -2719,6 +2859,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -2751,8 +2892,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -3201,6 +3344,24 @@ } } }, + "LegalArrangementRequest" : { + "properties" : { + "legalArrangementCode" : { + "description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.", + "type" : "string" + }, + "legalArrangementEntityCodes" : { + "description" : "List of legal arrangement entities to be deleted.", + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ + "legalArrangementCode" + ] + }, "PayoutScheduleResponse" : { "properties" : { "nextScheduledPayout" : { @@ -3209,32 +3370,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -3674,29 +3821,15 @@ "description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -3718,7 +3851,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/platforms/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/marketplaces-and-platforms/classic/verification-checks).", "format" : "byte", "type" : "string" }, @@ -4162,6 +4295,81 @@ ] } }, + "post-deleteLegalArrangements-arrangements" : { + "summary" : "Delete legal arrangements", + "description" : "Example request for deleting legal arrangements", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c" + } + ] + } + }, + "post-deleteLegalArrangements-arrangements-200" : { + "summary" : "Legal arrangement deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-arrangements-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementCode code is provided for value 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.legalArrangementCode", + "fieldName" : "legalArrangementCode" + } + } + ], + "pspReference" : "9916613322577326" + } + }, + "post-deleteLegalArrangements-entities" : { + "summary" : "Delete legal arrangement entities", + "description" : "Example request for deleting legal arrangement entities", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c", + "legalArrangementEntityCodes" : [ + "755881d3-d6b0-4b34-8ace-1caceb8add63" + ] + } + ] + } + }, + "post-deleteLegalArrangements-entities-200" : { + "summary" : "Legal arrangement entities deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-entities-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementEntityCode code is provided for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode", + "fieldName" : "legalArrangementEntityCode" + } + } + ], + "pspReference" : "9916613324987358" + } + }, "post-deleteShareholders-basic" : { "summary" : "Delete shareholders", "value" : { diff --git a/json/AccountService-v4.json b/json/AccountService-v4.json index 72a4f32..2f228af 100644 --- a/json/AccountService-v4.json +++ b/json/AccountService-v4.json @@ -8,9 +8,9 @@ "info" : { "version" : "4", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Account API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-06T09:18:38Z", + "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```", + "x-timestamp" : "2022-08-29T12:22:33Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -159,7 +159,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](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/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.", "operationId" : "post-closeAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -277,7 +277,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/platforms/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/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -395,7 +395,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", + "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).", "operationId" : "post-createAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -618,6 +618,141 @@ } } }, + "/deleteLegalArrangements" : { + "post" : { + "tags" : [ + "Verification" + ], + "summary" : "Delete legal arrangements", + "description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.", + "operationId" : "post-deleteLegalArrangements", + "x-groupName" : "Verification", + "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities" + } + }, + "schema" : { + "$ref" : "#/components/schemas/DeleteLegalArrangementRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-200" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "Accepted - the request has been accepted for processing, but the processing has not been completed." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-400" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-400" + }, + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/deleteShareholders" : { "post" : { "tags" : [ @@ -627,7 +762,7 @@ "description" : "Deletes shareholders associated with an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", - "x-sortIndex" : 6, + "x-sortIndex" : 7, "security" : [ { "BasicAuth" : [ @@ -745,7 +880,7 @@ "description" : "Deletes signatories associated with an account holder.", "operationId" : "post-deleteSignatories", "x-groupName" : "Verification", - "x-sortIndex" : 7, + "x-sortIndex" : 8, "security" : [ { "BasicAuth" : [ @@ -976,7 +1111,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/platforms/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/marketplaces-and-platforms/classic/tax-forms).", "operationId" : "post-getTaxForm", "x-groupName" : "Account holders", "x-sortIndex" : 8, @@ -1084,7 +1219,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/platforms/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/marketplaces-and-platforms/classic/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -1192,7 +1327,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "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**.", "operationId" : "post-suspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1310,7 +1445,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \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/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).", "operationId" : "post-unSuspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -1791,7 +1926,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/platforms/verification-process).", + "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).", "operationId" : "post-uploadDocument", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2380,12 +2515,13 @@ }, "primaryCurrency" : { "x-addedInVersion" : "4", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" } @@ -2479,29 +2615,15 @@ "description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" }, @@ -2582,6 +2704,25 @@ "bankAccountUUIDs" ] }, + "DeleteLegalArrangementRequest" : { + "properties" : { + "accountHolderCode" : { + "description" : "The code of the account holder.", + "type" : "string" + }, + "legalArrangements" : { + "description" : "List of legal arrangements.", + "items" : { + "$ref" : "#/components/schemas/LegalArrangementRequest" + }, + "type" : "array" + } + }, + "required" : [ + "accountHolderCode", + "legalArrangements" + ] + }, "DeleteShareholderRequest" : { "properties" : { "accountHolderCode" : { @@ -2629,7 +2770,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/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", + "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", "type" : "string" }, "description" : { @@ -2637,7 +2778,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/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", + "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", "enum" : [ "BANK_STATEMENT", "BSN", @@ -2659,7 +2800,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/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**. ", + "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**. ", "type" : "string" }, "signatoryCode" : { @@ -2745,6 +2886,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -2779,8 +2921,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -3245,6 +3389,24 @@ } } }, + "LegalArrangementRequest" : { + "properties" : { + "legalArrangementCode" : { + "description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.", + "type" : "string" + }, + "legalArrangementEntityCodes" : { + "description" : "List of legal arrangement entities to be deleted.", + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ + "legalArrangementCode" + ] + }, "PayoutScheduleResponse" : { "properties" : { "nextScheduledPayout" : { @@ -3253,32 +3415,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -3566,6 +3714,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "4", + "deprecated" : true, "description" : "The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.", "type" : "string" }, @@ -3753,29 +3902,15 @@ "description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -3797,7 +3932,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/platforms/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/marketplaces-and-platforms/classic/verification-checks).", "format" : "byte", "type" : "string" }, @@ -4044,6 +4179,81 @@ ] } }, + "post-deleteLegalArrangements-arrangements" : { + "summary" : "Delete legal arrangements", + "description" : "Example request for deleting legal arrangements", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c" + } + ] + } + }, + "post-deleteLegalArrangements-arrangements-200" : { + "summary" : "Legal arrangement deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-arrangements-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementCode code is provided for value 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.legalArrangementCode", + "fieldName" : "legalArrangementCode" + } + } + ], + "pspReference" : "9916613322577326" + } + }, + "post-deleteLegalArrangements-entities" : { + "summary" : "Delete legal arrangement entities", + "description" : "Example request for deleting legal arrangement entities", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c", + "legalArrangementEntityCodes" : [ + "755881d3-d6b0-4b34-8ace-1caceb8add63" + ] + } + ] + } + }, + "post-deleteLegalArrangements-entities-200" : { + "summary" : "Legal arrangement entities deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-entities-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementEntityCode code is provided for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode", + "fieldName" : "legalArrangementEntityCode" + } + } + ], + "pspReference" : "9916613324987358" + } + }, "post-deleteShareholders-basic" : { "summary" : "Delete shareholders", "value" : { diff --git a/json/AccountService-v5.json b/json/AccountService-v5.json index 64f31f1..55633de 100644 --- a/json/AccountService-v5.json +++ b/json/AccountService-v5.json @@ -8,9 +8,9 @@ "info" : { "version" : "5", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Account API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-06T09:18:38Z", + "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```", + "x-timestamp" : "2022-08-29T12:22:33Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -278,7 +278,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](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/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.", "operationId" : "post-closeAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -500,7 +500,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/platforms/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/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -618,7 +618,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", + "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).", "operationId" : "post-createAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -841,6 +841,141 @@ } } }, + "/deleteLegalArrangements" : { + "post" : { + "tags" : [ + "Verification" + ], + "summary" : "Delete legal arrangements", + "description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.", + "operationId" : "post-deleteLegalArrangements", + "x-groupName" : "Verification", + "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities" + } + }, + "schema" : { + "$ref" : "#/components/schemas/DeleteLegalArrangementRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-200" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "Accepted - the request has been accepted for processing, but the processing has not been completed." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-400" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-400" + }, + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/deletePayoutMethods" : { "post" : { "tags" : [ @@ -969,7 +1104,7 @@ "description" : "Deletes shareholders associated with an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", - "x-sortIndex" : 6, + "x-sortIndex" : 7, "security" : [ { "BasicAuth" : [ @@ -1087,7 +1222,7 @@ "description" : "Deletes signatories associated with an account holder.", "operationId" : "post-deleteSignatories", "x-groupName" : "Verification", - "x-sortIndex" : 7, + "x-sortIndex" : 8, "security" : [ { "BasicAuth" : [ @@ -1318,7 +1453,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/platforms/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/marketplaces-and-platforms/classic/tax-forms).", "operationId" : "post-getTaxForm", "x-groupName" : "Account holders", "x-sortIndex" : 8, @@ -1426,7 +1561,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/platforms/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/marketplaces-and-platforms/classic/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -1534,7 +1669,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "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**.", "operationId" : "post-suspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1652,7 +1787,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \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/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).", "operationId" : "post-unSuspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -2133,7 +2268,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/platforms/verification-process).", + "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).", "operationId" : "post-uploadDocument", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2813,12 +2948,13 @@ }, "primaryCurrency" : { "x-addedInVersion" : "4", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" } @@ -2873,6 +3009,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2931,29 +3068,15 @@ "description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" }, @@ -3077,6 +3200,25 @@ "bankAccountUUIDs" ] }, + "DeleteLegalArrangementRequest" : { + "properties" : { + "accountHolderCode" : { + "description" : "The code of the account holder.", + "type" : "string" + }, + "legalArrangements" : { + "description" : "List of legal arrangements.", + "items" : { + "$ref" : "#/components/schemas/LegalArrangementRequest" + }, + "type" : "array" + } + }, + "required" : [ + "accountHolderCode", + "legalArrangements" + ] + }, "DeletePayoutMethodRequest" : { "properties" : { "accountHolderCode" : { @@ -3143,7 +3285,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/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", + "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", "type" : "string" }, "description" : { @@ -3151,7 +3293,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/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", + "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", "enum" : [ "BANK_STATEMENT", "BSN", @@ -3175,7 +3317,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/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**. ", + "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**. ", "type" : "string" }, "signatoryCode" : { @@ -3261,6 +3403,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -3295,8 +3438,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -3809,6 +3954,24 @@ } } }, + "LegalArrangementRequest" : { + "properties" : { + "legalArrangementCode" : { + "description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.", + "type" : "string" + }, + "legalArrangementEntityCodes" : { + "description" : "List of legal arrangement entities to be deleted.", + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ + "legalArrangementCode" + ] + }, "PayoutMethod" : { "properties" : { "merchantAccount" : { @@ -3846,32 +4009,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -4079,6 +4228,11 @@ "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, + "logo" : { + "x-addedInVersion" : "5", + "description" : "Store logo for payment method setup.", + "type" : "string" + }, "merchantAccount" : { "description" : "The merchant account to which the store belongs.", "type" : "string" @@ -4087,6 +4241,11 @@ "description" : "The merchant category code (MCC) that classifies the business of the account holder.", "type" : "string" }, + "merchantHouseNumber" : { + "x-addedInVersion" : "5", + "description" : "Merchant house number for payment method setup.", + "type" : "string" + }, "phoneNumber" : { "description" : "The phone number of the store.", "$ref" : "#/components/schemas/ViasPhoneNumber" @@ -4289,6 +4448,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "4", + "deprecated" : true, "description" : "The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.", "type" : "string" }, @@ -4343,6 +4503,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -4530,29 +4691,15 @@ "description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -4564,7 +4711,7 @@ "UploadDocumentRequest" : { "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/platforms/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/marketplaces-and-platforms/classic/verification-checks).", "format" : "byte", "type" : "string" }, @@ -4808,6 +4955,81 @@ ] } }, + "post-deleteLegalArrangements-arrangements" : { + "summary" : "Delete legal arrangements", + "description" : "Example request for deleting legal arrangements", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c" + } + ] + } + }, + "post-deleteLegalArrangements-arrangements-200" : { + "summary" : "Legal arrangement deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-arrangements-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementCode code is provided for value 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.legalArrangementCode", + "fieldName" : "legalArrangementCode" + } + } + ], + "pspReference" : "9916613322577326" + } + }, + "post-deleteLegalArrangements-entities" : { + "summary" : "Delete legal arrangement entities", + "description" : "Example request for deleting legal arrangement entities", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c", + "legalArrangementEntityCodes" : [ + "755881d3-d6b0-4b34-8ace-1caceb8add63" + ] + } + ] + } + }, + "post-deleteLegalArrangements-entities-200" : { + "summary" : "Legal arrangement entities deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-entities-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementEntityCode code is provided for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode", + "fieldName" : "legalArrangementEntityCode" + } + } + ], + "pspReference" : "9916613324987358" + } + }, "post-deletePayoutMethods-basic" : { "summary" : "Delete a payout method", "value" : { diff --git a/json/AccountService-v6.json b/json/AccountService-v6.json index 3d71883..c5b203e 100644 --- a/json/AccountService-v6.json +++ b/json/AccountService-v6.json @@ -8,9 +8,9 @@ "info" : { "version" : "6", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Account API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-06T09:18:38Z", + "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```", + "x-timestamp" : "2022-08-29T12:22:33Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -278,7 +278,7 @@ "Account holders" ], "summary" : "Close an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Closed**. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a **Closed** [`status`](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/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.", "operationId" : "post-closeAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 7, @@ -500,7 +500,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/platforms/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/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts).", "operationId" : "post-createAccount", "x-groupName" : "Accounts", "x-sortIndex" : 1, @@ -618,7 +618,7 @@ "Account holders" ], "summary" : "Create an account holder", - "description" : "Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/platforms/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/platforms/account-holders-and-accounts#legal-entity-types).", + "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).", "operationId" : "post-createAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 1, @@ -841,6 +841,141 @@ } } }, + "/deleteLegalArrangements" : { + "post" : { + "tags" : [ + "Verification" + ], + "summary" : "Delete legal arrangements", + "description" : "Deletes legal arrangements and/or legal arrangement entities associated with an account holder.", + "operationId" : "post-deleteLegalArrangements", + "x-groupName" : "Verification", + "x-sortIndex" : 6, + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities" + } + }, + "schema" : { + "$ref" : "#/components/schemas/DeleteLegalArrangementRequest" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-200" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenericResponse" + } + } + }, + "description" : "Accepted - the request has been accepted for processing, but the processing has not been completed." + }, + "400" : { + "content" : { + "application/json" : { + "examples" : { + "arrangements" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-arrangements-400" + }, + "entities" : { + "$ref" : "#/components/examples/post-deleteLegalArrangements-entities-400" + }, + "generic" : { + "$ref" : "#/components/examples/generic-400" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "examples" : { + "generic" : { + "$ref" : "#/components/examples/generic-403" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/deletePayoutMethods" : { "post" : { "tags" : [ @@ -969,7 +1104,7 @@ "description" : "Deletes shareholders associated with an account holder.", "operationId" : "post-deleteShareholders", "x-groupName" : "Verification", - "x-sortIndex" : 6, + "x-sortIndex" : 7, "security" : [ { "BasicAuth" : [ @@ -1087,7 +1222,7 @@ "description" : "Deletes signatories associated with an account holder.", "operationId" : "post-deleteSignatories", "x-groupName" : "Verification", - "x-sortIndex" : 7, + "x-sortIndex" : 8, "security" : [ { "BasicAuth" : [ @@ -1318,7 +1453,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/platforms/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/marketplaces-and-platforms/classic/tax-forms).", "operationId" : "post-getTaxForm", "x-groupName" : "Account holders", "x-sortIndex" : 8, @@ -1426,7 +1561,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/platforms/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/marketplaces-and-platforms/classic/verification-process).\n", "operationId" : "post-getUploadedDocuments", "x-groupName" : "Verification", "x-sortIndex" : 2, @@ -1534,7 +1669,7 @@ "Account holders" ], "summary" : "Suspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) to **Suspended**.", + "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**.", "operationId" : "post-suspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 5, @@ -1652,7 +1787,7 @@ "Account holders" ], "summary" : "Unsuspend an account holder", - "description" : "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \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/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).", "operationId" : "post-unSuspendAccountHolder", "x-groupName" : "Account holders", "x-sortIndex" : 6, @@ -2133,7 +2268,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/platforms/verification-process).", + "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).", "operationId" : "post-uploadDocument", "x-groupName" : "Verification", "x-sortIndex" : 1, @@ -2838,12 +2973,13 @@ }, "primaryCurrency" : { "x-addedInVersion" : "4", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, "processingTier" : { "x-addedInVersion" : "3", - "description" : "The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", + "description" : "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.", "format" : "int32", "type" : "integer" }, @@ -2905,6 +3041,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2968,29 +3105,15 @@ "description" : "The payout schedule of the prospective account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" }, @@ -3114,6 +3237,25 @@ "bankAccountUUIDs" ] }, + "DeleteLegalArrangementRequest" : { + "properties" : { + "accountHolderCode" : { + "description" : "The code of the account holder.", + "type" : "string" + }, + "legalArrangements" : { + "description" : "List of legal arrangements.", + "items" : { + "$ref" : "#/components/schemas/LegalArrangementRequest" + }, + "type" : "array" + } + }, + "required" : [ + "accountHolderCode", + "legalArrangements" + ] + }, "DeletePayoutMethodRequest" : { "properties" : { "accountHolderCode" : { @@ -3180,7 +3322,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/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", + "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", "type" : "string" }, "description" : { @@ -3188,7 +3330,7 @@ "type" : "string" }, "documentType" : { - "description" : "The type of the document. Refer to [Verification checks](https://docs.adyen.com/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", + "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", "enum" : [ "BANK_STATEMENT", "BSN", @@ -3223,7 +3365,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/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**. ", + "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**. ", "type" : "string" }, "signatoryCode" : { @@ -3309,6 +3451,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -3343,8 +3486,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -4070,6 +4215,24 @@ "legalEntityType" ] }, + "LegalArrangementRequest" : { + "properties" : { + "legalArrangementCode" : { + "description" : "The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.", + "type" : "string" + }, + "legalArrangementEntityCodes" : { + "description" : "List of legal arrangement entities to be deleted.", + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ + "legalArrangementCode" + ] + }, "PayoutMethod" : { "properties" : { "merchantAccount" : { @@ -4107,32 +4270,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -4340,6 +4489,11 @@ "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, + "logo" : { + "x-addedInVersion" : "5", + "description" : "Store logo for payment method setup.", + "type" : "string" + }, "merchantAccount" : { "description" : "The merchant account to which the store belongs.", "type" : "string" @@ -4348,6 +4502,11 @@ "description" : "The merchant category code (MCC) that classifies the business of the account holder.", "type" : "string" }, + "merchantHouseNumber" : { + "x-addedInVersion" : "5", + "description" : "Merchant house number for payment method setup.", + "type" : "string" + }, "phoneNumber" : { "description" : "The phone number of the store.", "$ref" : "#/components/schemas/ViasPhoneNumber" @@ -4552,6 +4711,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "4", + "deprecated" : true, "description" : "The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.", "type" : "string" }, @@ -4613,6 +4773,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -4805,29 +4966,15 @@ "description" : "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -4839,7 +4986,7 @@ "UploadDocumentRequest" : { "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/platforms/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/marketplaces-and-platforms/classic/verification-checks).", "format" : "byte", "type" : "string" }, @@ -5083,6 +5230,81 @@ ] } }, + "post-deleteLegalArrangements-arrangements" : { + "summary" : "Delete legal arrangements", + "description" : "Example request for deleting legal arrangements", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c" + } + ] + } + }, + "post-deleteLegalArrangements-arrangements-200" : { + "summary" : "Legal arrangement deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-arrangements-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementCode code is provided for value 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.legalArrangementCode", + "fieldName" : "legalArrangementCode" + } + } + ], + "pspReference" : "9916613322577326" + } + }, + "post-deleteLegalArrangements-entities" : { + "summary" : "Delete legal arrangement entities", + "description" : "Example request for deleting legal arrangement entities", + "value" : { + "accountHolderCode" : "CODE_OF_ACCOUNT_HOLDER", + "legalArrangements" : [ + { + "legalArrangementCode" : "cdf92f5a-a114-4ce6-8f19-c3f6ec83141c", + "legalArrangementEntityCodes" : [ + "755881d3-d6b0-4b34-8ace-1caceb8add63" + ] + } + ] + } + }, + "post-deleteLegalArrangements-entities-200" : { + "summary" : "Legal arrangement entities deleted", + "value" : { + "invalidFields" : [ + ], + "pspReference" : "8816080397613514" + } + }, + "post-deleteLegalArrangements-entities-400" : { + "summary" : "Response code 400. Bad Request.", + "value" : { + "invalidFields" : [ + { + "errorCode" : 34, + "errorDescription" : "An invalid legalArrangementEntityCode code is provided for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf'", + "fieldType" : { + "field" : "AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode", + "fieldName" : "legalArrangementEntityCode" + } + } + ], + "pspReference" : "9916613324987358" + } + }, "post-deletePayoutMethods-basic" : { "summary" : "Delete a payout method", "value" : { diff --git a/json/FundService-v3.json b/json/FundService-v3.json index bacb07f..e75ff9c 100644 --- a/json/FundService-v3.json +++ b/json/FundService-v3.json @@ -8,9 +8,9 @@ "info" : { "version" : "3", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Fund API", - "description" : "The 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/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```", - "x-timestamp" : "2022-04-21T16:24:56Z", + "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```", + "x-timestamp" : "2022-08-25T18:26:01Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -232,7 +232,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/platforms/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/marketplaces-and-platforms/classic/top-up-accounts).", "operationId" : "post-debitAccountHolder", "x-groupName" : "General", "x-sortIndex" : 8, @@ -1267,7 +1267,7 @@ "type" : "string" }, "amount" : { - "description" : "The amount to pay out.", + "description" : "An object containing the currency and value of the payout.\nIf the account has multiple currencies, specify the currency to be used.\nIf the `bankAccountUUID` is provided in the request, the currency supported by the bank is used.\nIf the `payoutMethodCode` is provided in the request, the specified payout method is selected.", "$ref" : "#/components/schemas/Amount" }, "bankAccountUUID" : { @@ -1275,8 +1275,8 @@ "type" : "string" }, "description" : { - "description" : "A description of the payout. Maximum 35 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", - "maxLength" : 35, + "description" : "A description of the payout. Maximum 200 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", + "maxLength" : 200, "type" : "string" }, "merchantReference" : { diff --git a/json/FundService-v5.json b/json/FundService-v5.json index dbcf8c4..bdf3399 100644 --- a/json/FundService-v5.json +++ b/json/FundService-v5.json @@ -8,9 +8,9 @@ "info" : { "version" : "5", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Fund API", - "description" : "The 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/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```", - "x-timestamp" : "2022-04-21T16:24:56Z", + "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```", + "x-timestamp" : "2022-08-25T18:26:01Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -232,7 +232,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/platforms/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/marketplaces-and-platforms/classic/top-up-accounts).", "operationId" : "post-debitAccountHolder", "x-groupName" : "General", "x-sortIndex" : 8, @@ -1353,6 +1353,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -1387,8 +1388,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -1483,7 +1486,7 @@ "type" : "string" }, "amount" : { - "description" : "The amount to pay out.", + "description" : "An object containing the currency and value of the payout.\nIf the account has multiple currencies, specify the currency to be used.\nIf the `bankAccountUUID` is provided in the request, the currency supported by the bank is used.\nIf the `payoutMethodCode` is provided in the request, the specified payout method is selected.", "$ref" : "#/components/schemas/Amount" }, "bankAccountUUID" : { @@ -1491,8 +1494,8 @@ "type" : "string" }, "description" : { - "description" : "A description of the payout. Maximum 35 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", - "maxLength" : 35, + "description" : "A description of the payout. Maximum 200 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", + "maxLength" : 200, "type" : "string" }, "merchantReference" : { diff --git a/json/FundService-v6.json b/json/FundService-v6.json index 19f89cc..909a1d1 100644 --- a/json/FundService-v6.json +++ b/json/FundService-v6.json @@ -8,9 +8,9 @@ "info" : { "version" : "6", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Fund API", - "description" : "The 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/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```", - "x-timestamp" : "2022-04-21T16:24:56Z", + "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```", + "x-timestamp" : "2022-08-25T18:26:01Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -232,7 +232,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/platforms/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/marketplaces-and-platforms/classic/top-up-accounts).", "operationId" : "post-debitAccountHolder", "x-groupName" : "General", "x-sortIndex" : 8, @@ -1353,6 +1353,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -1387,8 +1388,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -1483,7 +1486,7 @@ "type" : "string" }, "amount" : { - "description" : "The amount to pay out.", + "description" : "An object containing the currency and value of the payout.\nIf the account has multiple currencies, specify the currency to be used.\nIf the `bankAccountUUID` is provided in the request, the currency supported by the bank is used.\nIf the `payoutMethodCode` is provided in the request, the specified payout method is selected.", "$ref" : "#/components/schemas/Amount" }, "bankAccountUUID" : { @@ -1491,8 +1494,8 @@ "type" : "string" }, "description" : { - "description" : "A description of the payout. Maximum 35 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", - "maxLength" : 35, + "description" : "A description of the payout. Maximum 200 characters.\nAllowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**", + "maxLength" : 200, "type" : "string" }, "merchantReference" : { diff --git a/json/HopService-v1.json b/json/HopService-v1.json index a15d622..8ff7d74 100644 --- a/json/HopService-v1.json +++ b/json/HopService-v1.json @@ -8,9 +8,9 @@ "info" : { "version" : "1", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Hosted Onboarding", - "description" : "The 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/platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:59Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -37,7 +37,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/platforms/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/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", "x-groupName" : "Hosted Onboarding Page", "x-sortIndex" : 1, @@ -140,7 +140,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/platforms/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/marketplaces-and-platforms/classic/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", "x-groupName" : "PCI Compliance Questionnaire Page", "x-sortIndex" : 1, @@ -243,27 +243,27 @@ "CollectInformation" : { "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Default is **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Default is **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Default is **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**.", "type" : "boolean" }, "legalArrangementDetails" : { - "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/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/marketplaces-and-platforms/classic/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/platforms/verification-checks/identity-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.", "type" : "boolean" } } @@ -339,6 +339,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -371,8 +372,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -462,7 +465,7 @@ "type" : "string" }, "collectInformation" : { - "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/platforms/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/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).", "$ref" : "#/components/schemas/CollectInformation" }, "editMode" : { @@ -478,7 +481,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 supported languages, refer to [Change the page language](https://docs.adyen.com/platforms/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/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).", "type" : "string" }, "showPages" : { diff --git a/json/HopService-v5.json b/json/HopService-v5.json index 8e3dc4b..bc989ae 100644 --- a/json/HopService-v5.json +++ b/json/HopService-v5.json @@ -8,9 +8,9 @@ "info" : { "version" : "5", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Hosted Onboarding", - "description" : "The 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/platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:59Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -37,7 +37,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/platforms/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/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", "x-groupName" : "Hosted Onboarding Page", "x-sortIndex" : 1, @@ -140,7 +140,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/platforms/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/marketplaces-and-platforms/classic/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", "x-groupName" : "PCI Compliance Questionnaire Page", "x-sortIndex" : 1, @@ -243,27 +243,27 @@ "CollectInformation" : { "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Default is **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Default is **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Default is **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**.", "type" : "boolean" }, "legalArrangementDetails" : { - "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/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/marketplaces-and-platforms/classic/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/platforms/verification-checks/identity-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.", "type" : "boolean" } } @@ -340,6 +340,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -374,8 +375,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -466,7 +469,7 @@ "type" : "string" }, "collectInformation" : { - "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/platforms/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/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).", "$ref" : "#/components/schemas/CollectInformation" }, "editMode" : { @@ -482,7 +485,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 supported languages, refer to [Change the page language](https://docs.adyen.com/platforms/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/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).", "type" : "string" }, "showPages" : { diff --git a/json/HopService-v6.json b/json/HopService-v6.json index 07d10e0..520ea84 100644 --- a/json/HopService-v6.json +++ b/json/HopService-v6.json @@ -8,9 +8,9 @@ "info" : { "version" : "6", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Hosted Onboarding", - "description" : "The 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/platforms/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:59Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -37,7 +37,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/platforms/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/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ", "operationId" : "post-getOnboardingUrl", "x-groupName" : "Hosted Onboarding Page", "x-sortIndex" : 1, @@ -140,7 +140,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/platforms/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/marketplaces-and-platforms/classic/platforms-for-partners).", "operationId" : "post-getPciQuestionnaireUrl", "x-groupName" : "PCI Compliance Questionnaire Page", "x-sortIndex" : 1, @@ -243,27 +243,27 @@ "CollectInformation" : { "properties" : { "bankDetails" : { - "description" : "Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) must be collected. Default is **true**.", + "description" : "Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**.", "type" : "boolean" }, "businessDetails" : { - "description" : "Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) must be collected. Default is **true**.", + "description" : "Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**.", "type" : "boolean" }, "individualDetails" : { - "description" : "Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) must be collected. Default is **true**.", + "description" : "Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**.", "type" : "boolean" }, "legalArrangementDetails" : { - "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) must be collected. Default is **true**.", + "description" : "Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/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/marketplaces-and-platforms/classic/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/platforms/verification-checks/identity-check) must be collected. Defaults to **true**.", + "description" : "Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**.", "type" : "boolean" } } @@ -340,6 +340,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -374,8 +375,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -466,7 +469,7 @@ "type" : "string" }, "collectInformation" : { - "description" : "Contains indicators whether the page should only collect information for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). By default, the page collects information for all KYC checks that apply to the [legal entity type](https://docs.adyen.com/platforms/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/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).", "$ref" : "#/components/schemas/CollectInformation" }, "editMode" : { @@ -482,7 +485,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 supported languages, refer to [Change the page language](https://docs.adyen.com/platforms/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/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).", "type" : "string" }, "showPages" : { diff --git a/json/MarketPayNotificationService-v3.json b/json/MarketPayNotificationService-v3.json index afbf039..d498251 100644 --- a/json/MarketPayNotificationService-v3.json +++ b/json/MarketPayNotificationService-v3.json @@ -5,7 +5,7 @@ "x-publicVersion" : true, "title" : "Adyen for Platforms: Notifications", "description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions 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/platforms/notifications).", - "x-timestamp" : "2022-05-06T09:18:38Z", + "x-timestamp" : "2022-08-16T10:21:11Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -1508,7 +1508,9 @@ "ApiTierUpdate", "CloseAccount", "CloseStores", + "DeleteBalanceAccounts", "DeleteBankAccounts", + "DeleteLegalArrangements", "DeleteLiableBankAccount", "DeletePayoutMethods", "DeleteShareholders", @@ -1519,8 +1521,8 @@ "RefundNotPaidOutTransfers", "ResolveEvents", "SaveAccountHolder", - "SaveCriminalityAndPEPChecks", "SaveKYCCheckStatus", + "SavePEPChecks", "SuspendAccount", "UnSuspendAccount", "UpdateAccountHolderState", @@ -2315,6 +2317,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -2347,8 +2350,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -2724,32 +2729,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } diff --git a/json/MarketPayNotificationService-v4.json b/json/MarketPayNotificationService-v4.json index dd97fc4..45cb23d 100644 --- a/json/MarketPayNotificationService-v4.json +++ b/json/MarketPayNotificationService-v4.json @@ -5,7 +5,7 @@ "x-publicVersion" : true, "title" : "Adyen for Platforms: Notifications", "description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions 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/platforms/notifications).", - "x-timestamp" : "2022-05-06T09:18:38Z", + "x-timestamp" : "2022-08-16T10:21:11Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -1564,7 +1564,9 @@ "ApiTierUpdate", "CloseAccount", "CloseStores", + "DeleteBalanceAccounts", "DeleteBankAccounts", + "DeleteLegalArrangements", "DeleteLiableBankAccount", "DeletePayoutMethods", "DeleteShareholders", @@ -1575,8 +1577,8 @@ "RefundNotPaidOutTransfers", "ResolveEvents", "SaveAccountHolder", - "SaveCriminalityAndPEPChecks", "SaveKYCCheckStatus", + "SavePEPChecks", "SuspendAccount", "UnSuspendAccount", "UpdateAccountHolderState", @@ -2437,6 +2439,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -2471,8 +2474,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -2843,32 +2848,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } diff --git a/json/MarketPayNotificationService-v5.json b/json/MarketPayNotificationService-v5.json index 0354737..733488c 100644 --- a/json/MarketPayNotificationService-v5.json +++ b/json/MarketPayNotificationService-v5.json @@ -5,7 +5,7 @@ "x-publicVersion" : true, "title" : "Adyen for Platforms: Notifications", "description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions 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/platforms/notifications).", - "x-timestamp" : "2022-05-06T09:18:38Z", + "x-timestamp" : "2022-08-16T10:21:11Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -1745,7 +1745,9 @@ "ApiTierUpdate", "CloseAccount", "CloseStores", + "DeleteBalanceAccounts", "DeleteBankAccounts", + "DeleteLegalArrangements", "DeleteLiableBankAccount", "DeletePayoutMethods", "DeleteShareholders", @@ -1756,8 +1758,8 @@ "RefundNotPaidOutTransfers", "ResolveEvents", "SaveAccountHolder", - "SaveCriminalityAndPEPChecks", "SaveKYCCheckStatus", + "SavePEPChecks", "SuspendAccount", "UnSuspendAccount", "UpdateAccountHolderState", @@ -2409,6 +2411,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2672,6 +2675,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -2706,8 +2710,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -3146,32 +3152,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -3622,6 +3614,11 @@ "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, + "logo" : { + "x-addedInVersion" : "5", + "description" : "Store logo for payment method setup.", + "type" : "string" + }, "merchantAccount" : { "description" : "The merchant account to which the store belongs.", "type" : "string" @@ -3630,6 +3627,11 @@ "description" : "The merchant category code (MCC) that classifies the business of the account holder.", "type" : "string" }, + "merchantHouseNumber" : { + "x-addedInVersion" : "5", + "description" : "Merchant house number for payment method setup.", + "type" : "string" + }, "phoneNumber" : { "description" : "The phone number of the store.", "$ref" : "#/components/schemas/ViasPhoneNumber" @@ -3971,6 +3973,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, diff --git a/json/MarketPayNotificationService-v6.json b/json/MarketPayNotificationService-v6.json index a4136de..acadf52 100644 --- a/json/MarketPayNotificationService-v6.json +++ b/json/MarketPayNotificationService-v6.json @@ -5,7 +5,7 @@ "x-publicVersion" : true, "title" : "Adyen for Platforms: Notifications", "description" : "The Notification API sends notifications to the endpoints specified in a given subscription. Subscriptions 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/platforms/notifications).", - "x-timestamp" : "2022-05-06T09:18:38Z", + "x-timestamp" : "2022-08-16T10:21:11Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -1780,7 +1780,9 @@ "ApiTierUpdate", "CloseAccount", "CloseStores", + "DeleteBalanceAccounts", "DeleteBankAccounts", + "DeleteLegalArrangements", "DeleteLiableBankAccount", "DeletePayoutMethods", "DeleteShareholders", @@ -1791,8 +1793,8 @@ "RefundNotPaidOutTransfers", "ResolveEvents", "SaveAccountHolder", - "SaveCriminalityAndPEPChecks", "SaveKYCCheckStatus", + "SavePEPChecks", "SuspendAccount", "UnSuspendAccount", "UpdateAccountHolderState", @@ -2472,6 +2474,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, @@ -2740,6 +2743,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -2774,8 +2778,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", @@ -3420,32 +3426,18 @@ "type" : "string" }, "schedule" : { - "description" : "The payout schedule of the account.\n>Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.", + "description" : "The payout schedule of the account.\nPermitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.", "enum" : [ "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT", - "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON", - "BI_DAILY_AU", - "BI_DAILY_EU", - "BI_DAILY_US", "DAILY", - "DAILY_6PM", "DAILY_AU", "DAILY_EU", "DAILY_SG", "DAILY_US", - "DEFAULT", - "EVERY_6_HOURS_FROM_MIDNIGHT", "HOLD", "MONTHLY", - "MONTHLY_ON_15TH_AT_MIDNIGHT", "WEEKLY", - "WEEKLY_MON_TO_FRI_AU", - "WEEKLY_MON_TO_FRI_EU", - "WEEKLY_MON_TO_FRI_US", - "WEEKLY_ON_TUE_FRI_MIDNIGHT", - "WEEKLY_SUN_TO_THU_AU", - "WEEKLY_SUN_TO_THU_US", - "YEARLY" + "WEEKLY_ON_TUE_FRI_MIDNIGHT" ], "type" : "string" } @@ -3896,6 +3888,11 @@ "description" : "The phone number of the store provided as a single string. It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"", "type" : "string" }, + "logo" : { + "x-addedInVersion" : "5", + "description" : "Store logo for payment method setup.", + "type" : "string" + }, "merchantAccount" : { "description" : "The merchant account to which the store belongs.", "type" : "string" @@ -3904,6 +3901,11 @@ "description" : "The merchant category code (MCC) that classifies the business of the account holder.", "type" : "string" }, + "merchantHouseNumber" : { + "x-addedInVersion" : "5", + "description" : "Merchant house number for payment method setup.", + "type" : "string" + }, "phoneNumber" : { "description" : "The phone number of the store.", "$ref" : "#/components/schemas/ViasPhoneNumber" @@ -4247,6 +4249,7 @@ }, "primaryCurrency" : { "x-addedInVersion" : "5", + "deprecated" : true, "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.", "type" : "string" }, diff --git a/json/NotificationConfigurationService-v1.json b/json/NotificationConfigurationService-v1.json index 9648b5d..5d6bf62 100644 --- a/json/NotificationConfigurationService-v1.json +++ b/json/NotificationConfigurationService-v1.json @@ -8,9 +8,9 @@ "info" : { "version" : "1", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Notification Configuration API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:58Z", "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 b08aebf..8920d7e 100644 --- a/json/NotificationConfigurationService-v2.json +++ b/json/NotificationConfigurationService-v2.json @@ -8,9 +8,9 @@ "info" : { "version" : "2", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Notification Configuration API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:58Z", "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 35fc6ff..16a5483 100644 --- a/json/NotificationConfigurationService-v3.json +++ b/json/NotificationConfigurationService-v3.json @@ -8,9 +8,9 @@ "info" : { "version" : "3", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Notification Configuration API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:58Z", "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 0722d5e..c76b7a8 100644 --- a/json/NotificationConfigurationService-v4.json +++ b/json/NotificationConfigurationService-v4.json @@ -8,9 +8,9 @@ "info" : { "version" : "4", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Notification Configuration API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:58Z", "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 6ede07e..d8b995e 100644 --- a/json/NotificationConfigurationService-v5.json +++ b/json/NotificationConfigurationService-v5.json @@ -8,9 +8,9 @@ "info" : { "version" : "5", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Notification Configuration API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:58Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -759,6 +759,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -793,8 +794,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", diff --git a/json/NotificationConfigurationService-v6.json b/json/NotificationConfigurationService-v6.json index 2d154b7..409ff7a 100644 --- a/json/NotificationConfigurationService-v6.json +++ b/json/NotificationConfigurationService-v6.json @@ -8,9 +8,9 @@ "info" : { "version" : "6", "x-publicVersion" : true, - "title" : "Adyen for Platforms: Notification Configuration API", - "description" : "The 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/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```", - "x-timestamp" : "2022-05-03T09:24:14Z", + "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```", + "x-timestamp" : "2022-07-28T16:19:58Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -759,6 +759,7 @@ "doingBusinessAs", "drivingLicence", "drivingLicenceBack", + "drivingLicenceFront", "drivingLicense", "email", "firstName", @@ -793,8 +794,10 @@ "legalBusinessName", "legalEntity", "legalEntityType", + "logo", "merchantAccount", "merchantCategoryCode", + "merchantHouseNumber", "merchantReference", "microDeposit", "name", diff --git a/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml index f514677..5027258 100644 --- a/yaml/AccountService-v3.yaml +++ b/yaml/AccountService-v3.yaml @@ -4,12 +4,14 @@ servers: info: version: '3' x-publicVersion: true - title: 'Adyen for Platforms: Account API' - description: "The Account API provides endpoints for managing account-related entities\ - \ on your platform. These related entities include account holders, accounts,\ + 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/platforms).\n\ + \ 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\"\ @@ -22,7 +24,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-29T12:22:33Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -114,7 +116,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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), @@ -189,7 +191,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/platforms/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-groupName: Accounts x-sortIndex: 1 @@ -259,10 +261,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/platforms/account-structure#your-platform) + 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/platforms/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-groupName: Account holders x-sortIndex: 1 @@ -408,6 +410,88 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /deleteLegalArrangements: + post: + tags: + - Verification + summary: Delete legal arrangements + description: Deletes legal arrangements and/or legal arrangement entities associated + with an account holder. + operationId: post-deleteLegalArrangements + x-groupName: Verification + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities' + schema: + $ref: '#/components/schemas/DeleteLegalArrangementRequest' + responses: + '200': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-200' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-200' + schema: + $ref: '#/components/schemas/GenericResponse' + description: OK - the request has succeeded. + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/GenericResponse' + description: Accepted - the request has been accepted for processing, but + the processing has not been completed. + '400': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-400' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-400' + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /deleteShareholders: post: tags: @@ -416,7 +500,7 @@ paths: description: Deletes shareholders associated with an account holder. operationId: post-deleteShareholders x-groupName: Verification - x-sortIndex: 6 + x-sortIndex: 7 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -486,7 +570,7 @@ paths: description: Deletes signatories associated with an account holder. operationId: post-deleteSignatories x-groupName: Verification - x-sortIndex: 7 + x-sortIndex: 8 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -623,7 +707,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/platforms/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). operationId: post-getTaxForm x-groupName: Account holders x-sortIndex: 8 @@ -687,7 +771,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/platforms/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). ' operationId: post-getUploadedDocuments @@ -752,7 +836,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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**. operationId: post-suspendAccountHolder x-groupName: Account holders @@ -823,7 +907,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses)\ + 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)\ @@ -1130,7 +1214,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/platforms/verification-process). + during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). operationId: post-uploadDocument x-groupName: Verification x-sortIndex: 1 @@ -1749,7 +1833,7 @@ components: type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -1817,29 +1901,15 @@ components: >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string payoutScheduleReason: description: 'The reason for the payout schedule choice. @@ -1906,6 +1976,19 @@ components: required: - accountHolderCode - bankAccountUUIDs + DeleteLegalArrangementRequest: + properties: + accountHolderCode: + description: The code of the account holder. + type: string + legalArrangements: + description: List of legal arrangements. + items: + $ref: '#/components/schemas/LegalArrangementRequest' + type: array + required: + - accountHolderCode + - legalArrangements DeleteShareholderRequest: properties: accountHolderCode: @@ -1941,7 +2024,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/platforms/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/marketplaces-and-platforms/classic/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 @@ -1953,7 +2036,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) + 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. @@ -2007,7 +2090,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/platforms/verification-checks) + 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. >Required if the account holder has a `legalEntity` of type **Business** @@ -2087,6 +2170,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -2119,8 +2203,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2523,6 +2609,19 @@ components: items: $ref: '#/components/schemas/KYCSignatoryCheckResult' type: array + LegalArrangementRequest: + properties: + legalArrangementCode: + description: The code of the legal arrangement to be deleted. If you also + send `legalArrangementEntityCodes`, only the entities listed will be deleted. + type: string + legalArrangementEntityCodes: + description: List of legal arrangement entities to be deleted. + items: + type: string + type: array + required: + - legalArrangementCode PayoutScheduleResponse: properties: nextScheduledPayout: @@ -2532,32 +2631,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3019,29 +3106,15 @@ components: manual payouts to occur.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3063,7 +3136,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/platforms/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' format: byte type: string documentDetail: @@ -3411,6 +3484,54 @@ components: accountHolderCode: CODE_OF_ACCOUNT_HOLDER bankAccountUUIDs: - eeb6ed22-3bae-483c-83b9-bc2097a75d40 + post-deleteLegalArrangements-arrangements: + summary: Delete legal arrangements + description: Example request for deleting legal arrangements + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + post-deleteLegalArrangements-arrangements-200: + summary: Legal arrangement deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-arrangements-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementCode code is provided for value + 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c' + fieldType: + field: AccountHolderDetails.LegalArrangements.legalArrangementCode + fieldName: legalArrangementCode + pspReference: '9916613322577326' + post-deleteLegalArrangements-entities: + summary: Delete legal arrangement entities + description: Example request for deleting legal arrangement entities + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + legalArrangementEntityCodes: + - 755881d3-d6b0-4b34-8ace-1caceb8add63 + post-deleteLegalArrangements-entities-200: + summary: Legal arrangement entities deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-entities-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementEntityCode code is provided + for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf' + fieldType: + field: AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode + fieldName: legalArrangementEntityCode + pspReference: '9916613324987358' post-deleteShareholders-basic: summary: Delete shareholders value: diff --git a/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index 439c6d9..a01c243 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -4,12 +4,14 @@ servers: info: version: '4' x-publicVersion: true - title: 'Adyen for Platforms: Account API' - description: "The Account API provides endpoints for managing account-related entities\ - \ on your platform. These related entities include account holders, accounts,\ + 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/platforms).\n\ + \ 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\"\ @@ -22,7 +24,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-29T12:22:33Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -114,7 +116,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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), @@ -189,7 +191,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/platforms/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-groupName: Accounts x-sortIndex: 1 @@ -259,10 +261,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/platforms/account-structure#your-platform) + 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/platforms/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-groupName: Account holders x-sortIndex: 1 @@ -392,6 +394,88 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /deleteLegalArrangements: + post: + tags: + - Verification + summary: Delete legal arrangements + description: Deletes legal arrangements and/or legal arrangement entities associated + with an account holder. + operationId: post-deleteLegalArrangements + x-groupName: Verification + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities' + schema: + $ref: '#/components/schemas/DeleteLegalArrangementRequest' + responses: + '200': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-200' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-200' + schema: + $ref: '#/components/schemas/GenericResponse' + description: OK - the request has succeeded. + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/GenericResponse' + description: Accepted - the request has been accepted for processing, but + the processing has not been completed. + '400': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-400' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-400' + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /deleteShareholders: post: tags: @@ -400,7 +484,7 @@ paths: description: Deletes shareholders associated with an account holder. operationId: post-deleteShareholders x-groupName: Verification - x-sortIndex: 6 + x-sortIndex: 7 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -470,7 +554,7 @@ paths: description: Deletes signatories associated with an account holder. operationId: post-deleteSignatories x-groupName: Verification - x-sortIndex: 7 + x-sortIndex: 8 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -607,7 +691,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/platforms/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). operationId: post-getTaxForm x-groupName: Account holders x-sortIndex: 8 @@ -671,7 +755,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/platforms/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). ' operationId: post-getUploadedDocuments @@ -736,7 +820,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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**. operationId: post-suspendAccountHolder x-groupName: Account holders @@ -807,7 +891,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses)\ + 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)\ @@ -1114,7 +1198,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/platforms/verification-process). + during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). operationId: post-uploadDocument x-groupName: Verification x-sortIndex: 1 @@ -1752,12 +1836,13 @@ components: type: string primaryCurrency: x-addedInVersion: '4' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -1844,29 +1929,15 @@ components: >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string payoutScheduleReason: description: 'The reason for the payout schedule choice. @@ -1937,6 +2008,19 @@ components: required: - accountHolderCode - bankAccountUUIDs + DeleteLegalArrangementRequest: + properties: + accountHolderCode: + description: The code of the account holder. + type: string + legalArrangements: + description: List of legal arrangements. + items: + $ref: '#/components/schemas/LegalArrangementRequest' + type: array + required: + - accountHolderCode + - legalArrangements DeleteShareholderRequest: properties: accountHolderCode: @@ -1972,7 +2056,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/platforms/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/marketplaces-and-platforms/classic/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 @@ -1984,7 +2068,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) + 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. @@ -2038,7 +2122,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/platforms/verification-checks) + 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. >Required if the account holder has a `legalEntity` of type **Business** @@ -2119,6 +2203,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -2153,8 +2238,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2571,6 +2658,19 @@ components: items: $ref: '#/components/schemas/KYCSignatoryCheckResult' type: array + LegalArrangementRequest: + properties: + legalArrangementCode: + description: The code of the legal arrangement to be deleted. If you also + send `legalArrangementEntityCodes`, only the entities listed will be deleted. + type: string + legalArrangementEntityCodes: + description: List of legal arrangement entities to be deleted. + items: + type: string + type: array + required: + - legalArrangementCode PayoutScheduleResponse: properties: nextScheduledPayout: @@ -2580,32 +2680,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -2909,6 +2997,7 @@ components: type: string primaryCurrency: x-addedInVersion: '4' + deprecated: true description: The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated. type: string @@ -3100,29 +3189,15 @@ components: manual payouts to occur.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3144,7 +3219,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/platforms/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' format: byte type: string documentDetail: @@ -3356,6 +3431,54 @@ components: accountHolderCode: CODE_OF_ACCOUNT_HOLDER bankAccountUUIDs: - eeb6ed22-3bae-483c-83b9-bc2097a75d40 + post-deleteLegalArrangements-arrangements: + summary: Delete legal arrangements + description: Example request for deleting legal arrangements + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + post-deleteLegalArrangements-arrangements-200: + summary: Legal arrangement deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-arrangements-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementCode code is provided for value + 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c' + fieldType: + field: AccountHolderDetails.LegalArrangements.legalArrangementCode + fieldName: legalArrangementCode + pspReference: '9916613322577326' + post-deleteLegalArrangements-entities: + summary: Delete legal arrangement entities + description: Example request for deleting legal arrangement entities + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + legalArrangementEntityCodes: + - 755881d3-d6b0-4b34-8ace-1caceb8add63 + post-deleteLegalArrangements-entities-200: + summary: Legal arrangement entities deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-entities-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementEntityCode code is provided + for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf' + fieldType: + field: AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode + fieldName: legalArrangementEntityCode + pspReference: '9916613324987358' post-deleteShareholders-basic: summary: Delete shareholders value: diff --git a/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index d966011..12f45a5 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -4,12 +4,14 @@ servers: info: version: '5' x-publicVersion: true - title: 'Adyen for Platforms: Account API' - description: "The Account API provides endpoints for managing account-related entities\ - \ on your platform. These related entities include account holders, accounts,\ + 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/platforms).\n\ + \ 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\"\ @@ -22,7 +24,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-29T12:22:33Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -186,7 +188,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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), @@ -322,7 +324,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/platforms/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-groupName: Accounts x-sortIndex: 1 @@ -392,10 +394,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/platforms/account-structure#your-platform) + 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/platforms/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-groupName: Account holders x-sortIndex: 1 @@ -525,6 +527,88 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /deleteLegalArrangements: + post: + tags: + - Verification + summary: Delete legal arrangements + description: Deletes legal arrangements and/or legal arrangement entities associated + with an account holder. + operationId: post-deleteLegalArrangements + x-groupName: Verification + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities' + schema: + $ref: '#/components/schemas/DeleteLegalArrangementRequest' + responses: + '200': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-200' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-200' + schema: + $ref: '#/components/schemas/GenericResponse' + description: OK - the request has succeeded. + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/GenericResponse' + description: Accepted - the request has been accepted for processing, but + the processing has not been completed. + '400': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-400' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-400' + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /deletePayoutMethods: post: tags: @@ -604,7 +688,7 @@ paths: description: Deletes shareholders associated with an account holder. operationId: post-deleteShareholders x-groupName: Verification - x-sortIndex: 6 + x-sortIndex: 7 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -674,7 +758,7 @@ paths: description: Deletes signatories associated with an account holder. operationId: post-deleteSignatories x-groupName: Verification - x-sortIndex: 7 + x-sortIndex: 8 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -811,7 +895,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/platforms/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). operationId: post-getTaxForm x-groupName: Account holders x-sortIndex: 8 @@ -875,7 +959,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/platforms/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). ' operationId: post-getUploadedDocuments @@ -940,7 +1024,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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**. operationId: post-suspendAccountHolder x-groupName: Account holders @@ -1011,7 +1095,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses)\ + 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)\ @@ -1318,7 +1402,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/platforms/verification-process). + during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). operationId: post-uploadDocument x-groupName: Verification x-sortIndex: 1 @@ -2031,12 +2115,13 @@ components: type: string primaryCurrency: x-addedInVersion: '4' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -2080,6 +2165,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string @@ -2143,29 +2229,15 @@ components: >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string payoutScheduleReason: description: 'The reason for the payout schedule choice. @@ -2271,6 +2343,19 @@ components: required: - accountHolderCode - bankAccountUUIDs + DeleteLegalArrangementRequest: + properties: + accountHolderCode: + description: The code of the account holder. + type: string + legalArrangements: + description: List of legal arrangements. + items: + $ref: '#/components/schemas/LegalArrangementRequest' + type: array + required: + - accountHolderCode + - legalArrangements DeletePayoutMethodRequest: properties: accountHolderCode: @@ -2320,7 +2405,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/platforms/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/marketplaces-and-platforms/classic/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 @@ -2332,7 +2417,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) + 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. @@ -2388,7 +2473,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/platforms/verification-checks) + 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. >Required if the account holder has a `legalEntity` of type **Business** @@ -2469,6 +2554,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -2503,8 +2589,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2924,6 +3012,19 @@ components: items: $ref: '#/components/schemas/KYCSignatoryCheckResult' type: array + LegalArrangementRequest: + properties: + legalArrangementCode: + description: The code of the legal arrangement to be deleted. If you also + send `legalArrangementEntityCodes`, only the entities listed will be deleted. + type: string + legalArrangementEntityCodes: + description: List of legal arrangement entities to be deleted. + items: + type: string + type: array + required: + - legalArrangementCode PayoutMethod: properties: merchantAccount: @@ -2963,32 +3064,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3220,6 +3309,10 @@ components: Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"' type: string + logo: + x-addedInVersion: '5' + description: Store logo for payment method setup. + type: string merchantAccount: description: The merchant account to which the store belongs. type: string @@ -3227,6 +3320,10 @@ components: description: The merchant category code (MCC) that classifies the business of the account holder. type: string + merchantHouseNumber: + x-addedInVersion: '5' + description: Merchant house number for payment method setup. + type: string phoneNumber: description: The phone number of the store. $ref: '#/components/schemas/ViasPhoneNumber' @@ -3412,6 +3509,7 @@ components: type: string primaryCurrency: x-addedInVersion: '4' + deprecated: true description: The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated. type: string @@ -3461,6 +3559,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string @@ -3652,29 +3751,15 @@ components: manual payouts to occur.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3684,7 +3769,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/platforms/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' format: byte type: string documentDetail: @@ -3890,6 +3975,54 @@ components: accountHolderCode: CODE_OF_ACCOUNT_HOLDER bankAccountUUIDs: - eeb6ed22-3bae-483c-83b9-bc2097a75d40 + post-deleteLegalArrangements-arrangements: + summary: Delete legal arrangements + description: Example request for deleting legal arrangements + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + post-deleteLegalArrangements-arrangements-200: + summary: Legal arrangement deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-arrangements-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementCode code is provided for value + 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c' + fieldType: + field: AccountHolderDetails.LegalArrangements.legalArrangementCode + fieldName: legalArrangementCode + pspReference: '9916613322577326' + post-deleteLegalArrangements-entities: + summary: Delete legal arrangement entities + description: Example request for deleting legal arrangement entities + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + legalArrangementEntityCodes: + - 755881d3-d6b0-4b34-8ace-1caceb8add63 + post-deleteLegalArrangements-entities-200: + summary: Legal arrangement entities deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-entities-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementEntityCode code is provided + for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf' + fieldType: + field: AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode + fieldName: legalArrangementEntityCode + pspReference: '9916613324987358' post-deletePayoutMethods-basic: summary: Delete a payout method value: diff --git a/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index 62061a6..654614f 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -4,12 +4,14 @@ servers: info: version: '6' x-publicVersion: true - title: 'Adyen for Platforms: Account API' - description: "The Account API provides endpoints for managing account-related entities\ - \ on your platform. These related entities include account holders, accounts,\ + 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/platforms).\n\ + \ 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\"\ @@ -22,7 +24,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-29T12:22:33Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -186,7 +188,7 @@ paths: tags: - Account holders summary: Close an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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), @@ -322,7 +324,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/platforms/account-holders-and-accounts#create-additional-accounts). + have [multiple accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#create-additional-accounts). operationId: post-createAccount x-groupName: Accounts x-sortIndex: 1 @@ -392,10 +394,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/platforms/account-structure#your-platform) + 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/platforms/account-holders-and-accounts#legal-entity-types). + holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). operationId: post-createAccountHolder x-groupName: Account holders x-sortIndex: 1 @@ -525,6 +527,88 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /deleteLegalArrangements: + post: + tags: + - Verification + summary: Delete legal arrangements + description: Deletes legal arrangements and/or legal arrangement entities associated + with an account holder. + operationId: post-deleteLegalArrangements + x-groupName: Verification + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities' + schema: + $ref: '#/components/schemas/DeleteLegalArrangementRequest' + responses: + '200': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-200' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-200' + schema: + $ref: '#/components/schemas/GenericResponse' + description: OK - the request has succeeded. + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/GenericResponse' + description: Accepted - the request has been accepted for processing, but + the processing has not been completed. + '400': + content: + application/json: + examples: + arrangements: + $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-400' + entities: + $ref: '#/components/examples/post-deleteLegalArrangements-entities-400' + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /deletePayoutMethods: post: tags: @@ -604,7 +688,7 @@ paths: description: Deletes shareholders associated with an account holder. operationId: post-deleteShareholders x-groupName: Verification - x-sortIndex: 6 + x-sortIndex: 7 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -674,7 +758,7 @@ paths: description: Deletes signatories associated with an account holder. operationId: post-deleteSignatories x-groupName: Verification - x-sortIndex: 7 + x-sortIndex: 8 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -811,7 +895,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/platforms/tax-forms). + more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/classic/tax-forms). operationId: post-getTaxForm x-groupName: Account holders x-sortIndex: 8 @@ -875,7 +959,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/platforms/verification-process). + holder. Adyen uses the documents during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). ' operationId: post-getUploadedDocuments @@ -940,7 +1024,7 @@ paths: tags: - Account holders summary: Suspend an account holder - description: Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses) + 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**. operationId: post-suspendAccountHolder x-groupName: Account holders @@ -1011,7 +1095,7 @@ paths: tags: - Account holders summary: Unsuspend an account holder - description: "Changes the [status of an account holder](https://docs.adyen.com/platforms/account-holders-and-accounts#account-holder-statuses)\ + 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)\ @@ -1318,7 +1402,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/platforms/verification-process). + during the [verification process](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process). operationId: post-uploadDocument x-groupName: Verification x-sortIndex: 1 @@ -2052,12 +2136,13 @@ components: type: string primaryCurrency: x-addedInVersion: '4' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string processingTier: x-addedInVersion: '3' - description: The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) + description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. format: int32 type: integer @@ -2107,6 +2192,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string @@ -2174,29 +2260,15 @@ components: >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string payoutScheduleReason: description: 'The reason for the payout schedule choice. @@ -2302,6 +2374,19 @@ components: required: - accountHolderCode - bankAccountUUIDs + DeleteLegalArrangementRequest: + properties: + accountHolderCode: + description: The code of the account holder. + type: string + legalArrangements: + description: List of legal arrangements. + items: + $ref: '#/components/schemas/LegalArrangementRequest' + type: array + required: + - accountHolderCode + - legalArrangements DeletePayoutMethodRequest: properties: accountHolderCode: @@ -2351,7 +2436,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/platforms/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/marketplaces-and-platforms/classic/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 @@ -2363,7 +2448,7 @@ components: description: Description of the document. type: string documentType: - description: 'The type of the document. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) + 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. @@ -2430,7 +2515,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/platforms/verification-checks) + 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. >Required if the account holder has a `legalEntity` of type **Business** @@ -2511,6 +2596,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -2545,8 +2631,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -3184,6 +3272,19 @@ components: type: string required: - legalEntityType + LegalArrangementRequest: + properties: + legalArrangementCode: + description: The code of the legal arrangement to be deleted. If you also + send `legalArrangementEntityCodes`, only the entities listed will be deleted. + type: string + legalArrangementEntityCodes: + description: List of legal arrangement entities to be deleted. + items: + type: string + type: array + required: + - legalArrangementCode PayoutMethod: properties: merchantAccount: @@ -3223,32 +3324,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3480,6 +3569,10 @@ components: Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"' type: string + logo: + x-addedInVersion: '5' + description: Store logo for payment method setup. + type: string merchantAccount: description: The merchant account to which the store belongs. type: string @@ -3487,6 +3580,10 @@ components: description: The merchant category code (MCC) that classifies the business of the account holder. type: string + merchantHouseNumber: + x-addedInVersion: '5' + description: Merchant house number for payment method setup. + type: string phoneNumber: description: The phone number of the store. $ref: '#/components/schemas/ViasPhoneNumber' @@ -3674,6 +3771,7 @@ components: type: string primaryCurrency: x-addedInVersion: '4' + deprecated: true description: The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated. type: string @@ -3729,6 +3827,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string @@ -3924,29 +4023,15 @@ components: manual payouts to occur.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3956,7 +4041,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/platforms/verification-checks).' + To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks).' format: byte type: string documentDetail: @@ -4162,6 +4247,54 @@ components: accountHolderCode: CODE_OF_ACCOUNT_HOLDER bankAccountUUIDs: - eeb6ed22-3bae-483c-83b9-bc2097a75d40 + post-deleteLegalArrangements-arrangements: + summary: Delete legal arrangements + description: Example request for deleting legal arrangements + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + post-deleteLegalArrangements-arrangements-200: + summary: Legal arrangement deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-arrangements-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementCode code is provided for value + 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c' + fieldType: + field: AccountHolderDetails.LegalArrangements.legalArrangementCode + fieldName: legalArrangementCode + pspReference: '9916613322577326' + post-deleteLegalArrangements-entities: + summary: Delete legal arrangement entities + description: Example request for deleting legal arrangement entities + value: + accountHolderCode: CODE_OF_ACCOUNT_HOLDER + legalArrangements: + - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c + legalArrangementEntityCodes: + - 755881d3-d6b0-4b34-8ace-1caceb8add63 + post-deleteLegalArrangements-entities-200: + summary: Legal arrangement entities deleted + value: + invalidFields: [] + pspReference: '8816080397613514' + post-deleteLegalArrangements-entities-400: + summary: Response code 400. Bad Request. + value: + invalidFields: + - errorCode: 34 + errorDescription: An invalid legalArrangementEntityCode code is provided + for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf' + fieldType: + field: AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode + fieldName: legalArrangementEntityCode + pspReference: '9916613324987358' post-deletePayoutMethods-basic: summary: Delete a payout method value: diff --git a/yaml/FundService-v3.yaml b/yaml/FundService-v3.yaml index d3304c9..d6db866 100644 --- a/yaml/FundService-v3.yaml +++ b/yaml/FundService-v3.yaml @@ -4,25 +4,27 @@ servers: info: version: '3' x-publicVersion: true - title: 'Adyen for Platforms: Fund API' - description: "The Fund API provides endpoints for managing the funds in the accounts\ + 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/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\ + \ 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\ ```" - x-timestamp: '2022-04-21T16:24:56Z' + x-timestamp: '2022-08-25T18:26:01Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -166,7 +168,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/platforms/top-up-accounts)." + \ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)." operationId: post-debitAccountHolder x-groupName: General x-sortIndex: 8 @@ -1068,7 +1070,15 @@ components: The Account Holder is the party to which the payout will be made.' type: string amount: - description: The amount to pay out. + description: 'An object containing the currency and value of the payout. + + If the account has multiple currencies, specify the currency to be used. + + If the `bankAccountUUID` is provided in the request, the currency supported + by the bank is used. + + If the `payoutMethodCode` is provided in the request, the specified payout + method is selected.' $ref: '#/components/schemas/Amount' bankAccountUUID: description: 'The unique ID of the Bank Account held by the Account Holder @@ -1077,11 +1087,11 @@ components: If left blank, a bank account is automatically selected.' type: string description: - description: 'A description of the payout. Maximum 35 characters. + description: 'A description of the payout. Maximum 200 characters. Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**' - maxLength: 35 + maxLength: 200 type: string merchantReference: x-addedInVersion: '2' diff --git a/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml index 49a2d73..4b43248 100644 --- a/yaml/FundService-v5.yaml +++ b/yaml/FundService-v5.yaml @@ -4,25 +4,27 @@ servers: info: version: '5' x-publicVersion: true - title: 'Adyen for Platforms: Fund API' - description: "The Fund API provides endpoints for managing the funds in the accounts\ + 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/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\ + \ 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\ ```" - x-timestamp: '2022-04-21T16:24:56Z' + x-timestamp: '2022-08-25T18:26:01Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -166,7 +168,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/platforms/top-up-accounts)." + \ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)." operationId: post-debitAccountHolder x-groupName: General x-sortIndex: 8 @@ -1120,6 +1122,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -1154,8 +1157,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -1247,7 +1252,15 @@ components: The Account Holder is the party to which the payout will be made.' type: string amount: - description: The amount to pay out. + description: 'An object containing the currency and value of the payout. + + If the account has multiple currencies, specify the currency to be used. + + If the `bankAccountUUID` is provided in the request, the currency supported + by the bank is used. + + If the `payoutMethodCode` is provided in the request, the specified payout + method is selected.' $ref: '#/components/schemas/Amount' bankAccountUUID: description: 'The unique ID of the Bank Account held by the Account Holder @@ -1256,11 +1269,11 @@ components: If left blank, a bank account is automatically selected.' type: string description: - description: 'A description of the payout. Maximum 35 characters. + description: 'A description of the payout. Maximum 200 characters. Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**' - maxLength: 35 + maxLength: 200 type: string merchantReference: x-addedInVersion: '2' diff --git a/yaml/FundService-v6.yaml b/yaml/FundService-v6.yaml index 4e03d58..efe0ce4 100644 --- a/yaml/FundService-v6.yaml +++ b/yaml/FundService-v6.yaml @@ -4,25 +4,27 @@ servers: info: version: '6' x-publicVersion: true - title: 'Adyen for Platforms: Fund API' - description: "The Fund API provides endpoints for managing the funds in the accounts\ + 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/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\ + \ 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\ ```" - x-timestamp: '2022-04-21T16:24:56Z' + x-timestamp: '2022-08-25T18:26:01Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -166,7 +168,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/platforms/top-up-accounts)." + \ accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/top-up-accounts)." operationId: post-debitAccountHolder x-groupName: General x-sortIndex: 8 @@ -1120,6 +1122,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -1154,8 +1157,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -1247,7 +1252,15 @@ components: The Account Holder is the party to which the payout will be made.' type: string amount: - description: The amount to pay out. + description: 'An object containing the currency and value of the payout. + + If the account has multiple currencies, specify the currency to be used. + + If the `bankAccountUUID` is provided in the request, the currency supported + by the bank is used. + + If the `payoutMethodCode` is provided in the request, the specified payout + method is selected.' $ref: '#/components/schemas/Amount' bankAccountUUID: description: 'The unique ID of the Bank Account held by the Account Holder @@ -1256,11 +1269,11 @@ components: If left blank, a bank account is automatically selected.' type: string description: - description: 'A description of the payout. Maximum 35 characters. + description: 'A description of the payout. Maximum 200 characters. Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**' - maxLength: 35 + maxLength: 200 type: string merchantReference: x-addedInVersion: '2' diff --git a/yaml/HopService-v1.yaml b/yaml/HopService-v1.yaml index f2fc40d..80e6941 100644 --- a/yaml/HopService-v1.yaml +++ b/yaml/HopService-v1.yaml @@ -4,10 +4,12 @@ servers: info: version: '1' x-publicVersion: true - title: 'Adyen for Platforms: Hosted Onboarding' - description: "The 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/platforms/hosted-onboarding-page)\ - \ or a [PCI compliance questionnaire](https://docs.adyen.com/platforms/platforms-for-partners).\ + 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\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:59Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -41,7 +43,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/platforms/collect-verification-details/hosted-onboarding-page). ' + to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-groupName: Hosted Onboarding Page x-sortIndex: 1 @@ -103,7 +105,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/platforms/platforms-for-partners)." + \ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-groupName: PCI Compliance Questionnaire Page x-sortIndex: 1 @@ -163,27 +165,27 @@ components: CollectInformation: properties: bankDetails: - description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) + description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**. type: boolean businessDetails: - description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) + description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**. type: boolean individualDetails: - description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) + description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**. type: boolean legalArrangementDetails: - description: Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) + description: Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/platforms-for-partners#onboard-partner-platform) + 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**. type: boolean shareholderDetails: - description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) + description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**. type: boolean ErrorFieldType: @@ -251,6 +253,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -283,8 +286,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -371,9 +376,9 @@ components: type: string collectInformation: description: Contains indicators whether the page should only collect information - for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). + 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/platforms/account-holders-and-accounts#legal-entity-types). + to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks @@ -394,8 +399,8 @@ components: \ 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 supported languages, refer\ - \ to [Change the page language](https://docs.adyen.com/platforms/hosted-onboarding-page/customize-experience#change-page-language)." + \ 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)." 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 517c990..4fbfb91 100644 --- a/yaml/HopService-v5.yaml +++ b/yaml/HopService-v5.yaml @@ -4,10 +4,12 @@ servers: info: version: '5' x-publicVersion: true - title: 'Adyen for Platforms: Hosted Onboarding' - description: "The 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/platforms/hosted-onboarding-page)\ - \ or a [PCI compliance questionnaire](https://docs.adyen.com/platforms/platforms-for-partners).\ + 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\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:59Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -41,7 +43,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/platforms/collect-verification-details/hosted-onboarding-page). ' + to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-groupName: Hosted Onboarding Page x-sortIndex: 1 @@ -103,7 +105,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/platforms/platforms-for-partners)." + \ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-groupName: PCI Compliance Questionnaire Page x-sortIndex: 1 @@ -163,27 +165,27 @@ components: CollectInformation: properties: bankDetails: - description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) + description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**. type: boolean businessDetails: - description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) + description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**. type: boolean individualDetails: - description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) + description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**. type: boolean legalArrangementDetails: - description: Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) + description: Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/platforms-for-partners#onboard-partner-platform) + 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**. type: boolean shareholderDetails: - description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) + description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**. type: boolean ErrorFieldType: @@ -252,6 +254,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -286,8 +289,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -375,9 +380,9 @@ components: type: string collectInformation: description: Contains indicators whether the page should only collect information - for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). + 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/platforms/account-holders-and-accounts#legal-entity-types). + to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks @@ -398,8 +403,8 @@ components: \ 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 supported languages, refer\ - \ to [Change the page language](https://docs.adyen.com/platforms/hosted-onboarding-page/customize-experience#change-page-language)." + \ 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)." 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 a40b2b2..5f67a10 100644 --- a/yaml/HopService-v6.yaml +++ b/yaml/HopService-v6.yaml @@ -4,10 +4,12 @@ servers: info: version: '6' x-publicVersion: true - title: 'Adyen for Platforms: Hosted Onboarding' - description: "The 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/platforms/hosted-onboarding-page)\ - \ or a [PCI compliance questionnaire](https://docs.adyen.com/platforms/platforms-for-partners).\ + 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\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:59Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -41,7 +43,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/platforms/collect-verification-details/hosted-onboarding-page). ' + to [Hosted onboarding](https://docs.adyen.com/marketplaces-and-platforms/classic/collect-verification-details/hosted-onboarding-page). ' operationId: post-getOnboardingUrl x-groupName: Hosted Onboarding Page x-sortIndex: 1 @@ -103,7 +105,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/platforms/platforms-for-partners)." + \ have a [partner platform setup](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners)." operationId: post-getPciQuestionnaireUrl x-groupName: PCI Compliance Questionnaire Page x-sortIndex: 1 @@ -163,27 +165,27 @@ components: CollectInformation: properties: bankDetails: - description: Indicates whether [bank account details](https://docs.adyen.com/platforms/verification-checks/bank-account-check) + description: Indicates whether [bank account details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check) must be collected. Default is **true**. type: boolean businessDetails: - description: Indicates whether [business details](https://docs.adyen.com/platforms/verification-checks/company-check) + description: Indicates whether [business details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/company-check) must be collected. Default is **true**. type: boolean individualDetails: - description: Indicates whether [individual details](https://docs.adyen.com/platforms/verification-checks/identity-check) + description: Indicates whether [individual details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Default is **true**. type: boolean legalArrangementDetails: - description: Indicates whether [legal arrangement details](https://docs.adyen.com/platforms/verification-checks/legal-arrangements) + description: Indicates whether [legal arrangement details](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/platforms-for-partners#onboard-partner-platform) + 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**. type: boolean shareholderDetails: - description: Indicates whether [shareholder details](https://docs.adyen.com/platforms/verification-checks/identity-check) + description: Indicates whether [shareholder details](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/identity-check) must be collected. Defaults to **true**. type: boolean ErrorFieldType: @@ -252,6 +254,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -286,8 +289,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -375,9 +380,9 @@ components: type: string collectInformation: description: Contains indicators whether the page should only collect information - for specific [KYC checks](https://docs.adyen.com/platforms/verification-checks). + 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/platforms/account-holders-and-accounts#legal-entity-types). + to the [legal entity type](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types). $ref: '#/components/schemas/CollectInformation' editMode: description: Indicates if editing checks is allowed even if all the checks @@ -398,8 +403,8 @@ components: \ 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 supported languages, refer\ - \ to [Change the page language](https://docs.adyen.com/platforms/hosted-onboarding-page/customize-experience#change-page-language)." + \ 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)." 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 fe5be22..e278669 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -9,7 +9,7 @@ info: For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).' - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-16T10:21:11Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -1027,7 +1027,9 @@ components: - ApiTierUpdate - CloseAccount - CloseStores + - DeleteBalanceAccounts - DeleteBankAccounts + - DeleteLegalArrangements - DeleteLiableBankAccount - DeletePayoutMethods - DeleteShareholders @@ -1038,8 +1040,8 @@ components: - RefundNotPaidOutTransfers - ResolveEvents - SaveAccountHolder - - SaveCriminalityAndPEPChecks - SaveKYCCheckStatus + - SavePEPChecks - SuspendAccount - UnSuspendAccount - UpdateAccountHolderState @@ -1846,6 +1848,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -1878,8 +1881,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2185,32 +2190,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index a70b2c9..297d230 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -9,7 +9,7 @@ info: For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).' - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-16T10:21:11Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -1075,7 +1075,9 @@ components: - ApiTierUpdate - CloseAccount - CloseStores + - DeleteBalanceAccounts - DeleteBankAccounts + - DeleteLegalArrangements - DeleteLiableBankAccount - DeletePayoutMethods - DeleteShareholders @@ -1086,8 +1088,8 @@ components: - RefundNotPaidOutTransfers - ResolveEvents - SaveAccountHolder - - SaveCriminalityAndPEPChecks - SaveKYCCheckStatus + - SavePEPChecks - SuspendAccount - UnSuspendAccount - UpdateAccountHolderState @@ -1950,6 +1952,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -1984,8 +1987,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2289,32 +2294,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index 7cf7af8..366d565 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -9,7 +9,7 @@ info: For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).' - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-16T10:21:11Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -1229,7 +1229,9 @@ components: - ApiTierUpdate - CloseAccount - CloseStores + - DeleteBalanceAccounts - DeleteBankAccounts + - DeleteLegalArrangements - DeleteLiableBankAccount - DeletePayoutMethods - DeleteShareholders @@ -1240,8 +1242,8 @@ components: - RefundNotPaidOutTransfers - ResolveEvents - SaveAccountHolder - - SaveCriminalityAndPEPChecks - SaveKYCCheckStatus + - SavePEPChecks - SuspendAccount - UnSuspendAccount - UpdateAccountHolderState @@ -1913,6 +1915,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string @@ -2140,6 +2143,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -2174,8 +2178,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2539,32 +2545,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3013,6 +3007,10 @@ components: Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"' type: string + logo: + x-addedInVersion: '5' + description: Store logo for payment method setup. + type: string merchantAccount: description: The merchant account to which the store belongs. type: string @@ -3020,6 +3018,10 @@ components: description: The merchant category code (MCC) that classifies the business of the account holder. type: string + merchantHouseNumber: + x-addedInVersion: '5' + description: Merchant house number for payment method setup. + type: string phoneNumber: description: The phone number of the store. $ref: '#/components/schemas/ViasPhoneNumber' @@ -3317,6 +3319,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index bf00218..fab0b1f 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -9,7 +9,7 @@ info: For more information, refer to our [documentation](https://docs.adyen.com/platforms/notifications).' - x-timestamp: '2022-05-06T09:18:38Z' + x-timestamp: '2022-08-16T10:21:11Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -1258,7 +1258,9 @@ components: - ApiTierUpdate - CloseAccount - CloseStores + - DeleteBalanceAccounts - DeleteBankAccounts + - DeleteLegalArrangements - DeleteLiableBankAccount - DeletePayoutMethods - DeleteShareholders @@ -1269,8 +1271,8 @@ components: - RefundNotPaidOutTransfers - ResolveEvents - SaveAccountHolder - - SaveCriminalityAndPEPChecks - SaveKYCCheckStatus + - SavePEPChecks - SuspendAccount - UnSuspendAccount - UpdateAccountHolderState @@ -1966,6 +1968,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string @@ -2197,6 +2200,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -2231,8 +2235,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name @@ -2808,32 +2814,20 @@ components: schedule: description: 'The payout schedule of the account. - >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`.' + Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, + `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`.' enum: - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT - - BIWEEKLY_ON_1ST_AND_15TH_AT_NOON - - BI_DAILY_AU - - BI_DAILY_EU - - BI_DAILY_US - DAILY - - DAILY_6PM - DAILY_AU - DAILY_EU - DAILY_SG - DAILY_US - - DEFAULT - - EVERY_6_HOURS_FROM_MIDNIGHT - HOLD - MONTHLY - - MONTHLY_ON_15TH_AT_MIDNIGHT - WEEKLY - - WEEKLY_MON_TO_FRI_AU - - WEEKLY_MON_TO_FRI_EU - - WEEKLY_MON_TO_FRI_US - WEEKLY_ON_TUE_FRI_MIDNIGHT - - WEEKLY_SUN_TO_THU_AU - - WEEKLY_SUN_TO_THU_US - - YEARLY type: string required: - schedule @@ -3282,6 +3276,10 @@ components: Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"' type: string + logo: + x-addedInVersion: '5' + description: Store logo for payment method setup. + type: string merchantAccount: description: The merchant account to which the store belongs. type: string @@ -3289,6 +3287,10 @@ components: description: The merchant category code (MCC) that classifies the business of the account holder. type: string + merchantHouseNumber: + x-addedInVersion: '5' + description: Merchant house number for payment method setup. + type: string phoneNumber: description: The phone number of the store. $ref: '#/components/schemas/ViasPhoneNumber' @@ -3588,6 +3590,7 @@ components: type: string primaryCurrency: x-addedInVersion: '5' + deprecated: true description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. type: string diff --git a/yaml/NotificationConfigurationService-v1.yaml b/yaml/NotificationConfigurationService-v1.yaml index 3d01861..def025d 100644 --- a/yaml/NotificationConfigurationService-v1.yaml +++ b/yaml/NotificationConfigurationService-v1.yaml @@ -4,11 +4,13 @@ servers: info: version: '1' x-publicVersion: true - title: 'Adyen for Platforms: Notification Configuration API' - description: "The Notification Configuration API provides endpoints for setting\ + 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/platforms/notifications).\n\ + \ 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\"\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/NotificationConfigurationService-v2.yaml b/yaml/NotificationConfigurationService-v2.yaml index b0be210..1c0d802 100644 --- a/yaml/NotificationConfigurationService-v2.yaml +++ b/yaml/NotificationConfigurationService-v2.yaml @@ -4,11 +4,13 @@ servers: info: version: '2' x-publicVersion: true - title: 'Adyen for Platforms: Notification Configuration API' - description: "The Notification Configuration API provides endpoints for setting\ + 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/platforms/notifications).\n\ + \ 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\"\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/NotificationConfigurationService-v3.yaml b/yaml/NotificationConfigurationService-v3.yaml index 0bff673..3390763 100644 --- a/yaml/NotificationConfigurationService-v3.yaml +++ b/yaml/NotificationConfigurationService-v3.yaml @@ -4,11 +4,13 @@ servers: info: version: '3' x-publicVersion: true - title: 'Adyen for Platforms: Notification Configuration API' - description: "The Notification Configuration API provides endpoints for setting\ + 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/platforms/notifications).\n\ + \ 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\"\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/NotificationConfigurationService-v4.yaml b/yaml/NotificationConfigurationService-v4.yaml index 669fa20..abec4d2 100644 --- a/yaml/NotificationConfigurationService-v4.yaml +++ b/yaml/NotificationConfigurationService-v4.yaml @@ -4,11 +4,13 @@ servers: info: version: '4' x-publicVersion: true - title: 'Adyen for Platforms: Notification Configuration API' - description: "The Notification Configuration API provides endpoints for setting\ + 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/platforms/notifications).\n\ + \ 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\"\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml index c8688f8..f035459 100644 --- a/yaml/NotificationConfigurationService-v5.yaml +++ b/yaml/NotificationConfigurationService-v5.yaml @@ -4,11 +4,13 @@ servers: info: version: '5' x-publicVersion: true - title: 'Adyen for Platforms: Notification Configuration API' - description: "The Notification Configuration API provides endpoints for setting\ + 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/platforms/notifications).\n\ + \ 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\"\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -499,6 +501,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -533,8 +536,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name diff --git a/yaml/NotificationConfigurationService-v6.yaml b/yaml/NotificationConfigurationService-v6.yaml index ace7d6f..a3be464 100644 --- a/yaml/NotificationConfigurationService-v6.yaml +++ b/yaml/NotificationConfigurationService-v6.yaml @@ -4,11 +4,13 @@ servers: info: version: '6' x-publicVersion: true - title: 'Adyen for Platforms: Notification Configuration API' - description: "The Notification Configuration API provides endpoints for setting\ + 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/platforms/notifications).\n\ + \ 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\"\ @@ -21,7 +23,7 @@ info: \ 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\ ```" - x-timestamp: '2022-05-03T09:24:14Z' + x-timestamp: '2022-07-28T16:19:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -499,6 +501,7 @@ components: - doingBusinessAs - drivingLicence - drivingLicenceBack + - drivingLicenceFront - drivingLicense - email - firstName @@ -533,8 +536,10 @@ components: - legalBusinessName - legalEntity - legalEntityType + - logo - merchantAccount - merchantCategoryCode + - merchantHouseNumber - merchantReference - microDeposit - name