From 81726ee11fe82551651b7dba78968cb20f186a3e Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 10 Jan 2023 09:13:57 +0000 Subject: [PATCH] spec release --- json/LegalEntityService-v1.json | 908 +++++++++++++++++++++++++++---- json/LegalEntityService-v2.json | 918 ++++++++++++++++++++++++++++---- yaml/LegalEntityService-v1.yaml | 664 +++++++++++++++++++---- yaml/LegalEntityService-v2.yaml | 674 +++++++++++++++++++---- 4 files changed, 2766 insertions(+), 398 deletions(-) diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json index d36e344..e91c042 100644 --- a/json/LegalEntityService-v1.json +++ b/json/LegalEntityService-v1.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Legal Entity Management API", "description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws12345@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through 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://kyc-test.adyen.com/lem/v1/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n", - "x-timestamp" : "2022-12-21T17:20:48Z", + "x-timestamp" : "2023-01-04T14:26:53Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -23,6 +23,7 @@ "Transfer instruments", "Business lines", "Documents", + "Terms of Service", "Hosted Onboarding" ], "tags" : [ @@ -38,6 +39,9 @@ { "name" : "Documents" }, + { + "name" : "Terms of Service" + }, { "name" : "Transfer instruments" } @@ -105,7 +109,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -115,7 +119,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -125,7 +129,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -135,7 +139,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -145,7 +149,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -207,7 +211,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -217,7 +221,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -227,7 +231,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -237,7 +241,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -247,7 +251,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -312,7 +316,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -322,7 +326,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -332,7 +336,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -342,7 +346,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -352,7 +356,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -409,7 +413,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -419,7 +423,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -429,7 +433,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -439,7 +443,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -449,7 +453,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -509,7 +513,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -519,7 +523,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -529,7 +533,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -539,7 +543,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -549,7 +553,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -623,7 +627,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -633,7 +637,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -643,7 +647,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -653,7 +657,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -663,7 +667,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -746,7 +750,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -756,7 +760,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -766,7 +770,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -776,7 +780,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -786,7 +790,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -848,7 +852,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -858,7 +862,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -868,7 +872,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -878,7 +882,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -888,7 +892,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -962,7 +966,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -972,7 +976,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -982,7 +986,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -992,7 +996,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1002,7 +1006,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1064,7 +1068,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1074,7 +1078,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1084,7 +1088,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1094,7 +1098,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1104,7 +1108,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1180,7 +1184,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1190,7 +1194,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1200,7 +1204,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1210,7 +1214,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1220,7 +1224,442 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfService" : { + "post" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get Terms of Service document", + "description" : "Returns the Terms of Service document for a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-termsOfService", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 2, + "x-methodName" : "getTermsOfServiceDocument", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "createTermsofService" : { + "$ref" : "#/components/examples/post-legalEntities-id-termsOfService-createTermsofService" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GetTermsOfServiceDocumentRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "createTermsofService" : { + "$ref" : "#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GetTermsOfServiceDocumentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfService/{termsofservicedocumentid}" : { + "patch" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Accept Terms of Service", + "description" : "Accepts Terms of Service.", + "x-addedInVersion" : "1", + "operationId" : "patch-legalEntities-id-termsOfService-termsofservicedocumentid", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 3, + "x-methodName" : "acceptTermsOfService", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AcceptTermsOfServiceRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The unique identifier of the Terms of Service document.", + "name" : "termsOfServiceDocumentId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AcceptTermsOfServiceResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfServiceAcceptanceInfos" : { + "get" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get Terms of Service information for a legal entity", + "description" : "Returns Terms of Service information for a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "get-legalEntities-id-termsOfServiceAcceptanceInfos", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 4, + "x-methodName" : "getTermsOfServiceInformationForLegalEntity", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "success" : { + "$ref" : "#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfServiceStatus" : { + "get" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get Terms of Service status", + "description" : "Returns the required types of Terms of Service that need to be accepted by a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "get-legalEntities-id-termsOfServiceStatus", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 1, + "x-methodName" : "getTermsOfServiceStatus", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "success" : { + "$ref" : "#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/CalculateTermsOfServiceStatusResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1271,7 +1710,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1281,7 +1720,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1291,7 +1730,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1301,7 +1740,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1311,7 +1750,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1373,7 +1812,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1383,7 +1822,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1393,7 +1832,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1403,7 +1842,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1413,7 +1852,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1484,7 +1923,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1494,7 +1933,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1504,7 +1943,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1514,7 +1953,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1524,7 +1963,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1581,7 +2020,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1591,7 +2030,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1601,7 +2040,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1611,7 +2050,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1621,7 +2060,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1681,7 +2120,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1691,7 +2130,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1701,7 +2140,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1711,7 +2150,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1721,7 +2160,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1785,7 +2224,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1795,7 +2234,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1805,7 +2244,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1815,7 +2254,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1825,7 +2264,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1837,6 +2276,51 @@ }, "components" : { "schemas" : { + "AcceptTermsOfServiceRequest" : { + "properties" : { + "acceptedBy" : { + "description" : "The unique identifier of the user accepting the Terms of Service.", + "type" : "string" + }, + "ipAddress" : { + "description" : "The IP address of the user accepting the Terms of Service.", + "type" : "string" + } + } + }, + "AcceptTermsOfServiceResponse" : { + "properties" : { + "acceptedBy" : { + "description" : "The unique identifier of the user that accepted the Terms of Service.", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the Terms of Service acceptance.", + "type" : "string" + }, + "ipAddress" : { + "description" : "The IP address of the user that accepted the Terms of Service.", + "type" : "string" + }, + "language" : { + "description" : "The language used for the Terms of Service document, specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. For example, **nl** for Dutch.", + "type" : "string" + }, + "termsOfServiceDocumentId" : { + "description" : "The unique identifier of the Terms of Service document.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, "Address" : { "properties" : { "city" : { @@ -1955,7 +2439,11 @@ "description" : "The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.", "type" : "string" } - } + }, + "required" : [ + "countryCode", + "currencyCode" + ] }, "BirthData" : { "properties" : { @@ -2071,6 +2559,22 @@ "businessLines" ] }, + "CalculateTermsOfServiceStatusResponse" : { + "properties" : { + "termsOfServiceTypes" : { + "description" : "The type of Terms of Service that the legal entity needs to accept. If empty, no Terms of Service needs to be accepted.", + "items" : { + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + }, + "type" : "array" + } + } + }, "CapabilityProblem" : { "properties" : { "entity" : { @@ -2255,6 +2759,64 @@ } } }, + "GetTermsOfServiceAcceptanceInfosResponse" : { + "properties" : { + "data" : { + "description" : "The Terms of Service acceptance information.", + "items" : { + "$ref" : "#/components/schemas/TermsOfServiceAcceptanceInfo" + }, + "type" : "array" + } + } + }, + "GetTermsOfServiceDocumentRequest" : { + "properties" : { + "language" : { + "description" : "The language to be used for the Terms of Service document, specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. For example, **nl** for Dutch.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, + "GetTermsOfServiceDocumentResponse" : { + "properties" : { + "document" : { + "description" : "The Terms of Service document in Base64-encoded format.", + "format" : "byte", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the legal entity.", + "type" : "string" + }, + "language" : { + "description" : "The language used for the Terms of Service document, specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. For example, **nl** for Dutch.", + "type" : "string" + }, + "termsOfServiceDocumentId" : { + "description" : "The unique identifier of the Terms of Service document.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, "IdentificationData" : { "properties" : { "cardNumber" : { @@ -2349,6 +2911,50 @@ "residentialAddress" ] }, + "InvalidField" : { + "properties" : { + "message" : { + "description" : "Description of the validation error.", + "type" : "string" + }, + "name" : { + "description" : "The field that has an invalid value.", + "type" : "string" + }, + "value" : { + "description" : "The invalid value.", + "type" : "string" + } + }, + "required" : [ + "name", + "value", + "message" + ] + }, + "JSONObject" : { + "properties" : { + "paths" : { + "items" : { + "$ref" : "#/components/schemas/JSONPath" + }, + "type" : "array" + }, + "rootPath" : { + "$ref" : "#/components/schemas/JSONPath" + } + } + }, + "JSONPath" : { + "properties" : { + "content" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + } + }, "LegalEntity" : { "properties" : { "capabilities" : { @@ -2601,6 +3207,13 @@ "description" : "The URL where the user is redirected after they complete hosted onboarding.", "type" : "string" }, + "settings" : { + "additionalProperties" : { + "type" : "boolean" + }, + "description" : "The enabled/disabled settings in the hosted onboarding webpage.", + "type" : "object" + }, "themeId" : { "description" : "The unique identifier of the hosted onboarding theme.", "type" : "string" @@ -2787,30 +3400,56 @@ } } }, - "ServiceError" : { + "RestServiceError" : { "properties" : { + "detail" : { + "description" : "A human-readable explanation specific to this occurrence of the problem.", + "type" : "string" + }, "errorCode" : { - "description" : "The error code mapped to the error message.", + "description" : "A code that identifies the problem type.", "type" : "string" }, - "errorType" : { - "description" : "The category of the error.", + "instance" : { + "description" : "A unique URI that identifies the specific occurrence of the problem.", "type" : "string" }, - "message" : { - "description" : "A short explanation of the issue.", + "invalidFields" : { + "description" : "Detailed explanation of each validation error, when applicable.", + "items" : { + "$ref" : "#/components/schemas/InvalidField" + }, + "type" : "array" + }, + "requestId" : { + "description" : "A unique reference for the request, essentially the same as `pspReference`.", "type" : "string" }, - "pspReference" : { - "description" : "The PSP reference of the payment.", - "type" : "string" + "response" : { + "description" : "JSON response payload.", + "$ref" : "#/components/schemas/JSONObject" }, "status" : { - "description" : "The HTTP response status.", + "description" : "The HTTP status code.", "format" : "int32", "type" : "integer" + }, + "title" : { + "description" : "A short, human-readable summary of the problem type.", + "type" : "string" + }, + "type" : { + "description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.", + "type" : "string" } - } + }, + "required" : [ + "type", + "errorCode", + "title", + "detail", + "status" + ] }, "SourceOfFunds" : { "properties" : { @@ -2883,6 +3522,36 @@ } } }, + "TermsOfServiceAcceptanceInfo" : { + "properties" : { + "acceptedBy" : { + "description" : "The unique identifier of the user that accepted the Terms of Service.", + "type" : "string" + }, + "acceptedFor" : { + "description" : "The unique identifier of the legal entity for which the Terms of Service are accepted.", + "type" : "string" + }, + "createdAt" : { + "description" : "The date when the Terms of Service were accepted.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "An Adyen-generated reference for the accepted Terms of Service.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, "TransferInstrument" : { "properties" : { "bankAccount" : { @@ -3307,6 +3976,30 @@ "id" : "LE322JV223222D5GG42KN6869" } }, + "get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200" : { + "summary" : "Terms of Service information for a legal entity", + "description" : "Example response when getting Terms of Service information for a legal entity", + "value" : { + "data" : [ + { + "acceptedBy" : "LE00000000000000000000002", + "acceptedFor" : "LE00000000000000000000001", + "createdAt" : "2022-12-05T13:36:58.212253Z", + "id" : "TOSA000AB00000000B2AAAB2BA0AA0", + "type" : "adyenIssuing" + } + ] + } + }, + "get-legalEntities-id-termsOfServiceStatus-success-200" : { + "summary" : "Terms of Service status for a legal entity", + "description" : "Example response when getting the type of Terms of Service", + "value" : { + "termsOfServiceTypes" : [ + "adyenIssuing" + ] + } + }, "get-themes-id-success-200" : { "summary" : "Details of a page theme", "description" : "Example response when getting the details of a page theme", @@ -3786,6 +4479,25 @@ "url" : "https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL" } }, + "post-legalEntities-id-termsOfService-createTermsofService" : { + "summary" : "Get the Terms of Service document", + "description" : "Example request for getting the Terms of Service document", + "value" : { + "type" : "adyenIssuing", + "language" : "en" + } + }, + "post-legalEntities-id-termsOfService-createTermsofService-200" : { + "summary" : "Terms of Service document returned", + "description" : "Example response for getting a Terms of Service document", + "value" : { + "id" : "LE00000000000000000000001", + "type" : "adyenIssuing", + "language" : "en", + "document" : "termsOfServiceDocumentResponse", + "termsOfServiceDocumentId" : "abc123" + } + }, "post-transferInstruments-createTransferInstrumentEUR" : { "summary" : "Add a EUR bank account", "description" : "Example request for creating a transfer instrument for EUR", diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index 1f7aa7d..e4b26ad 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Legal Entity Management API", "description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws12345@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through 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://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n", - "x-timestamp" : "2022-12-21T17:20:50Z", + "x-timestamp" : "2023-01-04T14:26:55Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -23,6 +23,7 @@ "Transfer instruments", "Business lines", "Documents", + "Terms of Service", "Hosted Onboarding" ], "tags" : [ @@ -38,6 +39,9 @@ { "name" : "Documents" }, + { + "name" : "Terms of Service" + }, { "name" : "Transfer instruments" } @@ -99,7 +103,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -109,7 +113,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -119,7 +123,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -129,7 +133,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -139,7 +143,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -201,7 +205,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -211,7 +215,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -221,7 +225,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -231,7 +235,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -241,7 +245,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -315,7 +319,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -325,7 +329,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -335,7 +339,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -345,7 +349,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -355,7 +359,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -420,7 +424,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -430,7 +434,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -440,7 +444,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -450,7 +454,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -460,7 +464,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -517,7 +521,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -527,7 +531,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -537,7 +541,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -547,7 +551,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -557,7 +561,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -617,7 +621,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -627,7 +631,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -637,7 +641,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -647,7 +651,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -657,7 +661,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -731,7 +735,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -741,7 +745,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -751,7 +755,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -761,7 +765,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -771,7 +775,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -866,7 +870,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -876,7 +880,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -886,7 +890,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -896,7 +900,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -906,7 +910,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -968,7 +972,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -978,7 +982,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -988,7 +992,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -998,7 +1002,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1008,7 +1012,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1088,7 +1092,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1098,7 +1102,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1108,7 +1112,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1118,7 +1122,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1128,7 +1132,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1190,7 +1194,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1200,7 +1204,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1210,7 +1214,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1220,7 +1224,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1230,7 +1234,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1306,7 +1310,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1316,7 +1320,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1326,7 +1330,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1336,7 +1340,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1346,7 +1350,442 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfService" : { + "post" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get Terms of Service document", + "description" : "Returns the Terms of Service document for a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-termsOfService", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 2, + "x-methodName" : "getTermsOfServiceDocument", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "createTermsofService" : { + "$ref" : "#/components/examples/post-legalEntities-id-termsOfService-createTermsofService" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GetTermsOfServiceDocumentRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "createTermsofService" : { + "$ref" : "#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GetTermsOfServiceDocumentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfService/{termsofservicedocumentid}" : { + "patch" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Accept Terms of Service", + "description" : "Accepts Terms of Service.", + "x-addedInVersion" : "1", + "operationId" : "patch-legalEntities-id-termsOfService-termsofservicedocumentid", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 3, + "x-methodName" : "acceptTermsOfService", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AcceptTermsOfServiceRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, + { + "description" : "The unique identifier of the Terms of Service document.", + "name" : "termsOfServiceDocumentId", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AcceptTermsOfServiceResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfServiceAcceptanceInfos" : { + "get" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get Terms of Service information for a legal entity", + "description" : "Returns Terms of Service information for a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "get-legalEntities-id-termsOfServiceAcceptanceInfos", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 4, + "x-methodName" : "getTermsOfServiceInformationForLegalEntity", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "success" : { + "$ref" : "#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, + "/legalEntities/{id}/termsOfServiceStatus" : { + "get" : { + "tags" : [ + "Terms of Service" + ], + "summary" : "Get Terms of Service status", + "description" : "Returns the required types of Terms of Service that need to be accepted by a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "get-legalEntities-id-termsOfServiceStatus", + "x-groupName" : "Terms of Service", + "x-sortIndex" : 1, + "x-methodName" : "getTermsOfServiceStatus", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "description" : "The unique identifier of the legal entity.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "success" : { + "$ref" : "#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200" + } + }, + "schema" : { + "$ref" : "#/components/schemas/CalculateTermsOfServiceStatusResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1397,7 +1836,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1407,7 +1846,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1417,7 +1856,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1427,7 +1866,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1437,7 +1876,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1499,7 +1938,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1509,7 +1948,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1519,7 +1958,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1529,7 +1968,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1539,7 +1978,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1610,7 +2049,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1620,7 +2059,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1630,7 +2069,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1640,7 +2079,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1650,7 +2089,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1707,7 +2146,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1717,7 +2156,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1727,7 +2166,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1737,7 +2176,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1747,7 +2186,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1807,7 +2246,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1817,7 +2256,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1827,7 +2266,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1837,7 +2276,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1847,7 +2286,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1911,7 +2350,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1921,7 +2360,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1931,7 +2370,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1941,7 +2380,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1951,7 +2390,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceError" + "$ref" : "#/components/schemas/RestServiceError" } } }, @@ -1963,6 +2402,51 @@ }, "components" : { "schemas" : { + "AcceptTermsOfServiceRequest" : { + "properties" : { + "acceptedBy" : { + "description" : "The unique identifier of the user accepting the Terms of Service.", + "type" : "string" + }, + "ipAddress" : { + "description" : "The IP address of the user accepting the Terms of Service.", + "type" : "string" + } + } + }, + "AcceptTermsOfServiceResponse" : { + "properties" : { + "acceptedBy" : { + "description" : "The unique identifier of the user that accepted the Terms of Service.", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the Terms of Service acceptance.", + "type" : "string" + }, + "ipAddress" : { + "description" : "The IP address of the user that accepted the Terms of Service.", + "type" : "string" + }, + "language" : { + "description" : "The language used for the Terms of Service document, specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. For example, **nl** for Dutch.", + "type" : "string" + }, + "termsOfServiceDocumentId" : { + "description" : "The unique identifier of the Terms of Service document.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, "Address" : { "properties" : { "city" : { @@ -2088,7 +2572,11 @@ "description" : "The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.", "type" : "string" } - } + }, + "required" : [ + "countryCode", + "currencyCode" + ] }, "BirthData" : { "properties" : { @@ -2242,6 +2730,22 @@ "businessLines" ] }, + "CalculateTermsOfServiceStatusResponse" : { + "properties" : { + "termsOfServiceTypes" : { + "description" : "The type of Terms of Service that the legal entity needs to accept. If empty, no Terms of Service needs to be accepted.", + "items" : { + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + }, + "type" : "array" + } + } + }, "CapabilityProblem" : { "properties" : { "entity" : { @@ -2444,6 +2948,64 @@ } } }, + "GetTermsOfServiceAcceptanceInfosResponse" : { + "properties" : { + "data" : { + "description" : "The Terms of Service acceptance information.", + "items" : { + "$ref" : "#/components/schemas/TermsOfServiceAcceptanceInfo" + }, + "type" : "array" + } + } + }, + "GetTermsOfServiceDocumentRequest" : { + "properties" : { + "language" : { + "description" : "The language to be used for the Terms of Service document, specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. For example, **nl** for Dutch.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, + "GetTermsOfServiceDocumentResponse" : { + "properties" : { + "document" : { + "description" : "The Terms of Service document in Base64-encoded format.", + "format" : "byte", + "type" : "string" + }, + "id" : { + "description" : "The unique identifier of the legal entity.", + "type" : "string" + }, + "language" : { + "description" : "The language used for the Terms of Service document, specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. For example, **nl** for Dutch.", + "type" : "string" + }, + "termsOfServiceDocumentId" : { + "description" : "The unique identifier of the Terms of Service document.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, "IdentificationData" : { "properties" : { "cardNumber" : { @@ -2548,6 +3110,50 @@ "residentialAddress" ] }, + "InvalidField" : { + "properties" : { + "message" : { + "description" : "Description of the validation error.", + "type" : "string" + }, + "name" : { + "description" : "The field that has an invalid value.", + "type" : "string" + }, + "value" : { + "description" : "The invalid value.", + "type" : "string" + } + }, + "required" : [ + "name", + "value", + "message" + ] + }, + "JSONObject" : { + "properties" : { + "paths" : { + "items" : { + "$ref" : "#/components/schemas/JSONPath" + }, + "type" : "array" + }, + "rootPath" : { + "$ref" : "#/components/schemas/JSONPath" + } + } + }, + "JSONPath" : { + "properties" : { + "content" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + } + }, "LegalEntity" : { "properties" : { "capabilities" : { @@ -2825,6 +3431,13 @@ "description" : "The URL where the user is redirected after they complete hosted onboarding.", "type" : "string" }, + "settings" : { + "additionalProperties" : { + "type" : "boolean" + }, + "description" : "The enabled/disabled settings in the hosted onboarding webpage.", + "type" : "object" + }, "themeId" : { "description" : "The unique identifier of the hosted onboarding theme.", "type" : "string" @@ -3017,30 +3630,56 @@ } } }, - "ServiceError" : { + "RestServiceError" : { "properties" : { + "detail" : { + "description" : "A human-readable explanation specific to this occurrence of the problem.", + "type" : "string" + }, "errorCode" : { - "description" : "The error code mapped to the error message.", + "description" : "A code that identifies the problem type.", "type" : "string" }, - "errorType" : { - "description" : "The category of the error.", + "instance" : { + "description" : "A unique URI that identifies the specific occurrence of the problem.", "type" : "string" }, - "message" : { - "description" : "A short explanation of the issue.", + "invalidFields" : { + "description" : "Detailed explanation of each validation error, when applicable.", + "items" : { + "$ref" : "#/components/schemas/InvalidField" + }, + "type" : "array" + }, + "requestId" : { + "description" : "A unique reference for the request, essentially the same as `pspReference`.", "type" : "string" }, - "pspReference" : { - "description" : "The PSP reference of the payment.", - "type" : "string" + "response" : { + "description" : "JSON response payload.", + "$ref" : "#/components/schemas/JSONObject" }, "status" : { - "description" : "The HTTP response status.", + "description" : "The HTTP status code.", "format" : "int32", "type" : "integer" + }, + "title" : { + "description" : "A short, human-readable summary of the problem type.", + "type" : "string" + }, + "type" : { + "description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.", + "type" : "string" } - } + }, + "required" : [ + "type", + "errorCode", + "title", + "detail", + "status" + ] }, "SoleProprietorship" : { "properties" : { @@ -3217,6 +3856,36 @@ } } }, + "TermsOfServiceAcceptanceInfo" : { + "properties" : { + "acceptedBy" : { + "description" : "The unique identifier of the user that accepted the Terms of Service.", + "type" : "string" + }, + "acceptedFor" : { + "description" : "The unique identifier of the legal entity for which the Terms of Service are accepted.", + "type" : "string" + }, + "createdAt" : { + "description" : "The date when the Terms of Service were accepted.", + "format" : "date-time", + "type" : "string" + }, + "id" : { + "description" : "An Adyen-generated reference for the accepted Terms of Service.", + "type" : "string" + }, + "type" : { + "description" : "The type of Terms of Service.", + "enum" : [ + "adyenForPlatformsAdvanced", + "adyenForPlatformsManage", + "adyenIssuing" + ], + "type" : "string" + } + } + }, "TransferInstrument" : { "properties" : { "bankAccount" : { @@ -3640,6 +4309,30 @@ "id" : "LE322JV223222D5GG42KN6869" } }, + "get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200" : { + "summary" : "Terms of Service information for a legal entity", + "description" : "Example response when getting Terms of Service information for a legal entity", + "value" : { + "data" : [ + { + "acceptedBy" : "LE00000000000000000000002", + "acceptedFor" : "LE00000000000000000000001", + "createdAt" : "2022-12-05T13:36:58.212253Z", + "id" : "TOSA000AB00000000B2AAAB2BA0AA0", + "type" : "adyenIssuing" + } + ] + } + }, + "get-legalEntities-id-termsOfServiceStatus-success-200" : { + "summary" : "Terms of Service status for a legal entity", + "description" : "Example response when getting the type of Terms of Service", + "value" : { + "termsOfServiceTypes" : [ + "adyenIssuing" + ] + } + }, "get-themes-id-success-200" : { "summary" : "Details of a page theme", "description" : "Example response when getting the details of a page theme", @@ -4234,6 +4927,25 @@ "url" : "https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL" } }, + "post-legalEntities-id-termsOfService-createTermsofService" : { + "summary" : "Get the Terms of Service document", + "description" : "Example request for getting the Terms of Service document", + "value" : { + "type" : "adyenIssuing", + "language" : "en" + } + }, + "post-legalEntities-id-termsOfService-createTermsofService-200" : { + "summary" : "Terms of Service document returned", + "description" : "Example response for getting a Terms of Service document", + "value" : { + "id" : "LE00000000000000000000001", + "type" : "adyenIssuing", + "language" : "en", + "document" : "termsOfServiceDocumentResponse", + "termsOfServiceDocumentId" : "abc123" + } + }, "post-transferInstruments-createTransferInstrumentEUR" : { "summary" : "Add a EUR bank account", "description" : "Example request for creating a transfer instrument for EUR", diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml index 5e8ee70..e3328b8 100644 --- a/yaml/LegalEntityService-v1.yaml +++ b/yaml/LegalEntityService-v1.yaml @@ -20,7 +20,7 @@ info: ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ \ credential for the live environment. You can then use the username and password\ \ to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n" - x-timestamp: '2022-12-21T17:20:48Z' + x-timestamp: '2023-01-04T14:26:53Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -31,12 +31,14 @@ x-groups: - Transfer instruments - Business lines - Documents +- Terms of Service - Hosted Onboarding tags: - name: Legal entities - name: Hosted Onboarding - name: Business lines - name: Documents +- name: Terms of Service - name: Transfer instruments paths: /businessLines: @@ -83,31 +85,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /businessLines/{id}: get: @@ -144,31 +146,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /documents: post: @@ -210,31 +212,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /documents/{id}: delete: @@ -268,31 +270,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. get: tags: @@ -328,31 +330,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -396,31 +398,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities: post: @@ -474,31 +476,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}: get: @@ -535,31 +537,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -606,31 +608,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}/businessLines: get: @@ -667,31 +669,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}/onboardingLinks: post: @@ -737,31 +739,292 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfService: + post: + tags: + - Terms of Service + summary: Get Terms of Service document + description: Returns the Terms of Service document for a legal entity. + x-addedInVersion: '1' + operationId: post-legalEntities-id-termsOfService + x-groupName: Terms of Service + x-sortIndex: 2 + x-methodName: getTermsOfServiceDocument + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + createTermsofService: + $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService' + schema: + $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest' + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + createTermsofService: + $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200' + schema: + $ref: '#/components/schemas/GetTermsOfServiceDocumentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfService/{termsofservicedocumentid}: + patch: + tags: + - Terms of Service + summary: Accept Terms of Service + description: Accepts Terms of Service. + x-addedInVersion: '1' + operationId: patch-legalEntities-id-termsOfService-termsofservicedocumentid + x-groupName: Terms of Service + x-sortIndex: 3 + x-methodName: acceptTermsOfService + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptTermsOfServiceRequest' + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + - description: The unique identifier of the Terms of Service document. + name: termsOfServiceDocumentId + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptTermsOfServiceResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfServiceAcceptanceInfos: + get: + tags: + - Terms of Service + summary: Get Terms of Service information for a legal entity + description: Returns Terms of Service information for a legal entity. + x-addedInVersion: '1' + operationId: get-legalEntities-id-termsOfServiceAcceptanceInfos + x-groupName: Terms of Service + x-sortIndex: 4 + x-methodName: getTermsOfServiceInformationForLegalEntity + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + success: + $ref: '#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200' + schema: + $ref: '#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfServiceStatus: + get: + tags: + - Terms of Service + summary: Get Terms of Service status + description: Returns the required types of Terms of Service that need to be + accepted by a legal entity. + x-addedInVersion: '1' + operationId: get-legalEntities-id-termsOfServiceStatus + x-groupName: Terms of Service + x-sortIndex: 1 + x-methodName: getTermsOfServiceStatus + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + success: + $ref: '#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200' + schema: + $ref: '#/components/schemas/CalculateTermsOfServiceStatusResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /themes: get: @@ -791,31 +1054,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /themes/{id}: get: @@ -852,31 +1115,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transferInstruments: post: @@ -924,31 +1187,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transferInstruments/{id}: delete: @@ -982,31 +1245,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. get: tags: @@ -1042,31 +1305,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -1104,34 +1367,69 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. components: schemas: + AcceptTermsOfServiceRequest: + properties: + acceptedBy: + description: The unique identifier of the user accepting the Terms of Service. + type: string + ipAddress: + description: The IP address of the user accepting the Terms of Service. + type: string + AcceptTermsOfServiceResponse: + properties: + acceptedBy: + description: The unique identifier of the user that accepted the Terms of + Service. + type: string + id: + description: The unique identifier of the Terms of Service acceptance. + type: string + ipAddress: + description: The IP address of the user that accepted the Terms of Service. + type: string + language: + description: The language used for the Terms of Service document, specified + by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + language code. For example, **nl** for Dutch. + type: string + termsOfServiceDocumentId: + description: The unique identifier of the Terms of Service document. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string Address: properties: city: @@ -1244,6 +1542,9 @@ components: description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. type: string + required: + - countryCode + - currencyCode BirthData: properties: dateOfBirth: @@ -1371,6 +1672,18 @@ components: type: array required: - businessLines + CalculateTermsOfServiceStatusResponse: + properties: + termsOfServiceTypes: + description: The type of Terms of Service that the legal entity needs to + accept. If empty, no Terms of Service needs to be accepted. + items: + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string + type: array CapabilityProblem: properties: entity: @@ -1517,6 +1830,51 @@ components: id: description: The unique identifier of the resource. type: string + GetTermsOfServiceAcceptanceInfosResponse: + properties: + data: + description: The Terms of Service acceptance information. + items: + $ref: '#/components/schemas/TermsOfServiceAcceptanceInfo' + type: array + GetTermsOfServiceDocumentRequest: + properties: + language: + description: The language to be used for the Terms of Service document, + specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + language code. For example, **nl** for Dutch. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string + GetTermsOfServiceDocumentResponse: + properties: + document: + description: The Terms of Service document in Base64-encoded format. + format: byte + type: string + id: + description: The unique identifier of the legal entity. + type: string + language: + description: The language used for the Terms of Service document, specified + by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + language code. For example, **nl** for Dutch. + type: string + termsOfServiceDocumentId: + description: The unique identifier of the Terms of Service document. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string IdentificationData: properties: cardNumber: @@ -1601,6 +1959,35 @@ components: required: - name - residentialAddress + InvalidField: + properties: + message: + description: Description of the validation error. + type: string + name: + description: The field that has an invalid value. + type: string + value: + description: The invalid value. + type: string + required: + - name + - value + - message + JSONObject: + properties: + paths: + items: + $ref: '#/components/schemas/JSONPath' + type: array + rootPath: + $ref: '#/components/schemas/JSONPath' + JSONPath: + properties: + content: + items: + type: string + type: array LegalEntity: properties: capabilities: @@ -1853,6 +2240,11 @@ components: description: The URL where the user is redirected after they complete hosted onboarding. type: string + settings: + additionalProperties: + type: boolean + description: The enabled/disabled settings in the hosted onboarding webpage. + type: object themeId: description: The unique identifier of the hosted onboarding theme. type: string @@ -2008,24 +2400,48 @@ components: type: string message: type: string - ServiceError: + RestServiceError: properties: + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string errorCode: - description: The error code mapped to the error message. + description: A code that identifies the problem type. type: string - errorType: - description: The category of the error. + instance: + description: A unique URI that identifies the specific occurrence of the + problem. type: string - message: - description: A short explanation of the issue. - type: string - pspReference: - description: The PSP reference of the payment. + invalidFields: + description: Detailed explanation of each validation error, when applicable. + items: + $ref: '#/components/schemas/InvalidField' + type: array + requestId: + description: A unique reference for the request, essentially the same as + `pspReference`. type: string + response: + description: JSON response payload. + $ref: '#/components/schemas/JSONObject' status: - description: The HTTP response status. + description: The HTTP status code. format: int32 type: integer + title: + description: A short, human-readable summary of the problem type. + type: string + type: + description: A URI that identifies the problem type, pointing to human-readable + documentation on this problem type. + type: string + required: + - type + - errorCode + - title + - detail + - status SourceOfFunds: properties: acquiringBusinessLineId: @@ -2112,6 +2528,30 @@ components: ' readOnly: true type: string + TermsOfServiceAcceptanceInfo: + properties: + acceptedBy: + description: The unique identifier of the user that accepted the Terms of + Service. + type: string + acceptedFor: + description: The unique identifier of the legal entity for which the Terms + of Service are accepted. + type: string + createdAt: + description: The date when the Terms of Service were accepted. + format: date-time + type: string + id: + description: An Adyen-generated reference for the accepted Terms of Service. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string TransferInstrument: properties: bankAccount: @@ -2445,6 +2885,23 @@ components: street2: '274' type: individual id: LE322JV223222D5GG42KN6869 + get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200: + summary: Terms of Service information for a legal entity + description: Example response when getting Terms of Service information for + a legal entity + value: + data: + - acceptedBy: LE00000000000000000000002 + acceptedFor: LE00000000000000000000001 + createdAt: '2022-12-05T13:36:58.212253Z' + id: TOSA000AB00000000B2AAAB2BA0AA0 + type: adyenIssuing + get-legalEntities-id-termsOfServiceStatus-success-200: + summary: Terms of Service status for a legal entity + description: Example response when getting the type of Terms of Service + value: + termsOfServiceTypes: + - adyenIssuing get-themes-id-success-200: summary: Details of a page theme description: Example response when getting the details of a page theme @@ -2810,6 +3267,21 @@ components: description: Example response for a hosted onboarding link value: url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL + post-legalEntities-id-termsOfService-createTermsofService: + summary: Get the Terms of Service document + description: Example request for getting the Terms of Service document + value: + type: adyenIssuing + language: en + post-legalEntities-id-termsOfService-createTermsofService-200: + summary: Terms of Service document returned + description: Example response for getting a Terms of Service document + value: + id: LE00000000000000000000001 + type: adyenIssuing + language: en + document: termsOfServiceDocumentResponse + termsOfServiceDocumentId: abc123 post-transferInstruments-createTransferInstrumentEUR: summary: Add a EUR bank account description: Example request for creating a transfer instrument for EUR diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index 05cb2ea..3e8df11 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -20,7 +20,7 @@ info: ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ \ credential for the live environment. You can then use the username and password\ \ to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n" - x-timestamp: '2022-12-21T17:20:50Z' + x-timestamp: '2023-01-04T14:26:55Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -31,12 +31,14 @@ x-groups: - Transfer instruments - Business lines - Documents +- Terms of Service - Hosted Onboarding tags: - name: Legal entities - name: Hosted Onboarding - name: Business lines - name: Documents +- name: Terms of Service - name: Transfer instruments paths: /businessLines: @@ -79,31 +81,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /businessLines/{id}: get: @@ -140,31 +142,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -208,31 +210,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /documents: post: @@ -274,31 +276,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /documents/{id}: delete: @@ -332,31 +334,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. get: tags: @@ -392,31 +394,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -460,31 +462,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities: post: @@ -546,31 +548,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}: get: @@ -607,31 +609,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -682,31 +684,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}/businessLines: get: @@ -743,31 +745,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /legalEntities/{id}/onboardingLinks: post: @@ -813,31 +815,292 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfService: + post: + tags: + - Terms of Service + summary: Get Terms of Service document + description: Returns the Terms of Service document for a legal entity. + x-addedInVersion: '1' + operationId: post-legalEntities-id-termsOfService + x-groupName: Terms of Service + x-sortIndex: 2 + x-methodName: getTermsOfServiceDocument + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + createTermsofService: + $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService' + schema: + $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest' + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + createTermsofService: + $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200' + schema: + $ref: '#/components/schemas/GetTermsOfServiceDocumentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfService/{termsofservicedocumentid}: + patch: + tags: + - Terms of Service + summary: Accept Terms of Service + description: Accepts Terms of Service. + x-addedInVersion: '1' + operationId: patch-legalEntities-id-termsOfService-termsofservicedocumentid + x-groupName: Terms of Service + x-sortIndex: 3 + x-methodName: acceptTermsOfService + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptTermsOfServiceRequest' + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + - description: The unique identifier of the Terms of Service document. + name: termsOfServiceDocumentId + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptTermsOfServiceResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfServiceAcceptanceInfos: + get: + tags: + - Terms of Service + summary: Get Terms of Service information for a legal entity + description: Returns Terms of Service information for a legal entity. + x-addedInVersion: '1' + operationId: get-legalEntities-id-termsOfServiceAcceptanceInfos + x-groupName: Terms of Service + x-sortIndex: 4 + x-methodName: getTermsOfServiceInformationForLegalEntity + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + success: + $ref: '#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200' + schema: + $ref: '#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/termsOfServiceStatus: + get: + tags: + - Terms of Service + summary: Get Terms of Service status + description: Returns the required types of Terms of Service that need to be + accepted by a legal entity. + x-addedInVersion: '1' + operationId: get-legalEntities-id-termsOfServiceStatus + x-groupName: Terms of Service + x-sortIndex: 1 + x-methodName: getTermsOfServiceStatus + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: The unique identifier of the legal entity. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + success: + $ref: '#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200' + schema: + $ref: '#/components/schemas/CalculateTermsOfServiceStatusResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /themes: get: @@ -867,31 +1130,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /themes/{id}: get: @@ -928,31 +1191,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transferInstruments: post: @@ -1000,31 +1263,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. /transferInstruments/{id}: delete: @@ -1058,31 +1321,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. get: tags: @@ -1118,31 +1381,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. patch: tags: @@ -1180,34 +1443,69 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: - $ref: '#/components/schemas/ServiceError' + $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. components: schemas: + AcceptTermsOfServiceRequest: + properties: + acceptedBy: + description: The unique identifier of the user accepting the Terms of Service. + type: string + ipAddress: + description: The IP address of the user accepting the Terms of Service. + type: string + AcceptTermsOfServiceResponse: + properties: + acceptedBy: + description: The unique identifier of the user that accepted the Terms of + Service. + type: string + id: + description: The unique identifier of the Terms of Service acceptance. + type: string + ipAddress: + description: The IP address of the user that accepted the Terms of Service. + type: string + language: + description: The language used for the Terms of Service document, specified + by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + language code. For example, **nl** for Dutch. + type: string + termsOfServiceDocumentId: + description: The unique identifier of the Terms of Service document. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string Address: properties: city: @@ -1326,6 +1624,9 @@ components: description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. type: string + required: + - countryCode + - currencyCode BirthData: properties: dateOfBirth: @@ -1503,6 +1804,18 @@ components: type: array required: - businessLines + CalculateTermsOfServiceStatusResponse: + properties: + termsOfServiceTypes: + description: The type of Terms of Service that the legal entity needs to + accept. If empty, no Terms of Service needs to be accepted. + items: + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string + type: array CapabilityProblem: properties: entity: @@ -1665,6 +1978,51 @@ components: id: description: The unique identifier of the resource. type: string + GetTermsOfServiceAcceptanceInfosResponse: + properties: + data: + description: The Terms of Service acceptance information. + items: + $ref: '#/components/schemas/TermsOfServiceAcceptanceInfo' + type: array + GetTermsOfServiceDocumentRequest: + properties: + language: + description: The language to be used for the Terms of Service document, + specified by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + language code. For example, **nl** for Dutch. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string + GetTermsOfServiceDocumentResponse: + properties: + document: + description: The Terms of Service document in Base64-encoded format. + format: byte + type: string + id: + description: The unique identifier of the legal entity. + type: string + language: + description: The language used for the Terms of Service document, specified + by the two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + language code. For example, **nl** for Dutch. + type: string + termsOfServiceDocumentId: + description: The unique identifier of the Terms of Service document. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string IdentificationData: properties: cardNumber: @@ -1760,6 +2118,35 @@ components: required: - name - residentialAddress + InvalidField: + properties: + message: + description: Description of the validation error. + type: string + name: + description: The field that has an invalid value. + type: string + value: + description: The invalid value. + type: string + required: + - name + - value + - message + JSONObject: + properties: + paths: + items: + $ref: '#/components/schemas/JSONPath' + type: array + rootPath: + $ref: '#/components/schemas/JSONPath' + JSONPath: + properties: + content: + items: + type: string + type: array LegalEntity: properties: capabilities: @@ -2035,6 +2422,11 @@ components: description: The URL where the user is redirected after they complete hosted onboarding. type: string + settings: + additionalProperties: + type: boolean + description: The enabled/disabled settings in the hosted onboarding webpage. + type: object themeId: description: The unique identifier of the hosted onboarding theme. type: string @@ -2192,24 +2584,48 @@ components: type: string message: type: string - ServiceError: + RestServiceError: properties: + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string errorCode: - description: The error code mapped to the error message. + description: A code that identifies the problem type. type: string - errorType: - description: The category of the error. + instance: + description: A unique URI that identifies the specific occurrence of the + problem. type: string - message: - description: A short explanation of the issue. - type: string - pspReference: - description: The PSP reference of the payment. + invalidFields: + description: Detailed explanation of each validation error, when applicable. + items: + $ref: '#/components/schemas/InvalidField' + type: array + requestId: + description: A unique reference for the request, essentially the same as + `pspReference`. type: string + response: + description: JSON response payload. + $ref: '#/components/schemas/JSONObject' status: - description: The HTTP response status. + description: The HTTP status code. format: int32 type: integer + title: + description: A short, human-readable summary of the problem type. + type: string + type: + description: A URI that identifies the problem type, pointing to human-readable + documentation on this problem type. + type: string + required: + - type + - errorCode + - title + - detail + - status SoleProprietorship: properties: countryOfGoverningLaw: @@ -2397,6 +2813,30 @@ components: - nonFinancialActive - nonFinancialPassive type: string + TermsOfServiceAcceptanceInfo: + properties: + acceptedBy: + description: The unique identifier of the user that accepted the Terms of + Service. + type: string + acceptedFor: + description: The unique identifier of the legal entity for which the Terms + of Service are accepted. + type: string + createdAt: + description: The date when the Terms of Service were accepted. + format: date-time + type: string + id: + description: An Adyen-generated reference for the accepted Terms of Service. + type: string + type: + description: The type of Terms of Service. + enum: + - adyenForPlatformsAdvanced + - adyenForPlatformsManage + - adyenIssuing + type: string TransferInstrument: properties: bankAccount: @@ -2729,6 +3169,23 @@ components: street2: '274' type: individual id: LE322JV223222D5GG42KN6869 + get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200: + summary: Terms of Service information for a legal entity + description: Example response when getting Terms of Service information for + a legal entity + value: + data: + - acceptedBy: LE00000000000000000000002 + acceptedFor: LE00000000000000000000001 + createdAt: '2022-12-05T13:36:58.212253Z' + id: TOSA000AB00000000B2AAAB2BA0AA0 + type: adyenIssuing + get-legalEntities-id-termsOfServiceStatus-success-200: + summary: Terms of Service status for a legal entity + description: Example response when getting the type of Terms of Service + value: + termsOfServiceTypes: + - adyenIssuing get-themes-id-success-200: summary: Details of a page theme description: Example response when getting the details of a page theme @@ -3184,6 +3641,21 @@ components: description: Example response for a hosted onboarding link value: url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL + post-legalEntities-id-termsOfService-createTermsofService: + summary: Get the Terms of Service document + description: Example request for getting the Terms of Service document + value: + type: adyenIssuing + language: en + post-legalEntities-id-termsOfService-createTermsofService-200: + summary: Terms of Service document returned + description: Example response for getting a Terms of Service document + value: + id: LE00000000000000000000001 + type: adyenIssuing + language: en + document: termsOfServiceDocumentResponse + termsOfServiceDocumentId: abc123 post-transferInstruments-createTransferInstrumentEUR: summary: Add a EUR bank account description: Example request for creating a transfer instrument for EUR