jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
patch-1
adyen-openapi/json/LegalEntityService-v2.json
Adyen Automation 0c12d70141 spec release
2023-01-30 09:01:19 +00:00

5090 lines
207 KiB
JSON
Raw Permalink Blame History

{
"openapi" : "3.1.0",
"servers" : [
{
"url" : "https://kyc-test.adyen.com/lem/v2"
}
],
"info" : {
"version" : "2",
"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" : "2023-01-27T19:25:03Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://www.adyen.help/hc/en-us/community/topics",
"email" : "developer-experience@adyen.com"
}
},
"x-groups" : [
"Legal entities",
"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" : {
"post" : {
"tags" : [
"Business lines"
],
"summary" : "Create a business line",
"description" : "Creates a business line. \n\nThis resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.",
"x-addedInVersion" : "1",
"operationId" : "post-businessLines",
"x-groupName" : "Business lines",
"x-sortIndex" : 12,
"x-methodName" : "createBusinessLine",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createBusinessLines-businessAccounts" : {
"$ref" : "#/components/examples/post-businessLines-createBusinessLines-businessAccounts"
}
},
"schema" : {
"$ref" : "#/components/schemas/BusinessLineInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"createBusinessLines-businessAccounts" : {
"$ref" : "#/components/examples/post-businessLines-createBusinessLines-businessAccounts-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/BusinessLine"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/businessLines/{id}" : {
"get" : {
"tags" : [
"Business lines"
],
"summary" : "Get a business line",
"description" : "Returns the detail of a business line.",
"x-addedInVersion" : "1",
"operationId" : "get-businessLines-id",
"x-groupName" : "Business lines",
"x-sortIndex" : 13,
"x-methodName" : "getBusinessLine",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the business line.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-businessLines-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/BusinessLine"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"tags" : [
"Business lines"
],
"summary" : "Update a business line",
"description" : "Updates a business line.",
"x-addedInVersion" : "2",
"operationId" : "patch-businessLines-id",
"x-groupName" : "Business lines",
"x-sortIndex" : 15,
"x-methodName" : "updateBusinessLine",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateBusinessLine" : {
"$ref" : "#/components/examples/patch-businessLines-id-updateBusinessLine"
}
},
"schema" : {
"$ref" : "#/components/schemas/BusinessLineInfoUpdate"
}
}
}
},
"parameters" : [
{
"description" : "The unique identifier of the business line.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"updateBusinessLine" : {
"$ref" : "#/components/examples/patch-businessLines-id-updateBusinessLine-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/BusinessLine"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/businessLines/{id}/legalEntities/{leid}" : {
"delete" : {
"tags" : [
"Business lines"
],
"summary" : "Delete a business line",
"description" : "Deletes a business line.\n\n >\"If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.",
"x-addedInVersion" : "1",
"operationId" : "delete-businessLines-id-legalEntities-leid",
"x-groupName" : "Business lines",
"x-sortIndex" : 14,
"x-methodName" : "deleteBusinessLine",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the business line.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"204" : {
"description" : "No Content - the request has been successfully processed, but there is no additional content."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/documents" : {
"post" : {
"tags" : [
"Documents"
],
"summary" : "Upload a document for verification checks",
"description" : "Uploads a document for verification checks.\n\n Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents.\n\n You should only upload documents when Adyen requests additional information for the legal entity. ",
"x-addedInVersion" : "1",
"operationId" : "post-documents",
"x-groupName" : "Documents",
"x-sortIndex" : 4,
"x-methodName" : "uploadDocumentForVerificationChecks",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"uploadDocument" : {
"$ref" : "#/components/examples/post-documents-uploadDocument"
}
},
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"uploadDocument" : {
"$ref" : "#/components/examples/post-documents-uploadDocument-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/documents/{id}" : {
"delete" : {
"tags" : [
"Documents"
],
"summary" : "Delete a document",
"description" : "Deletes a document.",
"x-addedInVersion" : "1",
"operationId" : "delete-documents-id",
"x-groupName" : "Documents",
"x-sortIndex" : 7,
"x-methodName" : "deleteDocument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the document to be deleted.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VoidResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"get" : {
"tags" : [
"Documents"
],
"summary" : "Get a document",
"description" : "Returns a document.",
"x-addedInVersion" : "1",
"operationId" : "get-documents-id",
"x-groupName" : "Documents",
"x-sortIndex" : 5,
"x-methodName" : "getDocument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the document.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-documents-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"tags" : [
"Documents"
],
"summary" : "Update a document",
"description" : "Updates a document.",
"x-addedInVersion" : "1",
"operationId" : "patch-documents-id",
"x-groupName" : "Documents",
"x-sortIndex" : 6,
"x-methodName" : "updateDocument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateDocument" : {
"$ref" : "#/components/examples/patch-documents-id-updateDocument"
}
},
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
}
},
"parameters" : [
{
"description" : "The unique identifier of the document to be updated.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"uploadDocument" : {
"$ref" : "#/components/examples/patch-documents-id-uploadDocument-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities" : {
"post" : {
"tags" : [
"Legal entities"
],
"summary" : "Create a legal entity",
"description" : "Creates a legal entity. \n\nThis resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. \n\n",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities",
"x-groupName" : "Legal entities",
"x-sortIndex" : 1,
"x-methodName" : "createLegalEntity",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createLegalEntityIndividualNL" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityIndividualNL"
},
"createLegalEntityIndividualUS" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityIndividualUS"
},
"createLegalEntityOrganizationNL" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationNL"
},
"createLegalEntityOrganizationUS" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationUS"
},
"createLegalEntitySolePropNL" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropNL"
},
"createLegalEntitySolePropUS" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropUS"
}
},
"schema" : {
"$ref" : "#/components/schemas/LegalEntityInfoRequiredType"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"createLegalEntityIndividualNL" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityIndividualNL-200"
},
"createLegalEntityIndividualUS" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityIndividualUS-200"
},
"createLegalEntityOrganizationNL" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationNL-200"
},
"createLegalEntityOrganizationUS" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntityOrganizationUS-200"
},
"createLegalEntitySolePropNL" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200"
},
"createLegalEntitySolePropUS" : {
"$ref" : "#/components/examples/post-legalEntities-createLegalEntitySolePropUS-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/LegalEntity"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}" : {
"get" : {
"tags" : [
"Legal entities"
],
"summary" : "Get a legal entity",
"description" : "Returns a legal entity.",
"x-addedInVersion" : "1",
"operationId" : "get-legalEntities-id",
"x-groupName" : "Legal entities",
"x-sortIndex" : 2,
"x-methodName" : "getLegalEntity",
"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-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/LegalEntity"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"tags" : [
"Legal entities"
],
"summary" : "Update a legal entity",
"description" : "Updates a legal entity.\n\n >To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.",
"x-addedInVersion" : "1",
"operationId" : "patch-legalEntities-id",
"x-groupName" : "Legal entities",
"x-sortIndex" : 3,
"x-methodName" : "updateLegalEntity",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateLegalEntityOrganization" : {
"$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization"
},
"updateLegalEntitySoleProp" : {
"$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp"
}
},
"schema" : {
"$ref" : "#/components/schemas/LegalEntityInfo"
}
}
}
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"updateLegalEntityOrganization" : {
"$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization-200"
},
"updateLegalEntitySoleProp" : {
"$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/LegalEntity"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}/businessLines" : {
"get" : {
"tags" : [
"Legal entities"
],
"summary" : "Get all business lines under a legal entity",
"description" : "Returns the business lines owned by a legal entity.",
"x-addedInVersion" : "1",
"operationId" : "get-legalEntities-id-businessLines",
"x-groupName" : "Legal entities",
"x-sortIndex" : 4,
"x-methodName" : "getAllBusinessLinesUnderLegalEntity",
"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-businessLines-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/BusinessLines"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}/onboardingLinks" : {
"post" : {
"tags" : [
"Hosted Onboarding"
],
"summary" : "Get a link to an Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities-id-onboardingLinks",
"x-groupName" : "Hosted Onboarding",
"x-sortIndex" : 1,
"x-methodName" : "getLinkToAdyenhostedOnboardingPage",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createOnboardingLink" : {
"$ref" : "#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink"
}
},
"schema" : {
"$ref" : "#/components/schemas/OnboardingLinkInfo"
}
}
}
},
"parameters" : [
{
"description" : "The unique identifier of the legal entity",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"createOnboardingLink" : {
"$ref" : "#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/OnboardingLink"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/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/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/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/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/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/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/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/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/themes" : {
"get" : {
"tags" : [
"Hosted Onboarding"
],
"summary" : "Get a list of hosted onboarding page themes",
"description" : "Returns a list of hosted onboarding page themes.",
"x-addedInVersion" : "1",
"operationId" : "get-themes",
"x-groupName" : "Hosted Onboarding",
"x-sortIndex" : 2,
"x-methodName" : "listHostedOnboardingPageThemes",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-themes-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/OnboardingThemes"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/themes/{id}" : {
"get" : {
"tags" : [
"Hosted Onboarding"
],
"summary" : "Get an onboarding link theme",
"description" : "Returns the details of the theme identified in the path.",
"x-addedInVersion" : "1",
"operationId" : "get-themes-id",
"x-groupName" : "Hosted Onboarding",
"x-sortIndex" : 4,
"x-methodName" : "getOnboardingLinkTheme",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the theme",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-themes-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/OnboardingTheme"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transferInstruments" : {
"post" : {
"tags" : [
"Transfer instruments"
],
"summary" : "Create a transfer instrument",
"description" : "Creates a transfer instrument. \n\nA transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses.\n\nWhen the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).",
"x-addedInVersion" : "1",
"operationId" : "post-transferInstruments",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 8,
"x-methodName" : "createTransferInstrument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createTransferInstrumentEUR" : {
"$ref" : "#/components/examples/post-transferInstruments-createTransferInstrumentEUR"
},
"createTransferInstrumentUSD" : {
"$ref" : "#/components/examples/post-transferInstruments-createTransferInstrumentUSD"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransferInstrumentInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"createTransferInstrumentEUR" : {
"$ref" : "#/components/examples/post-transferInstruments-createTransferInstrumentEUR-200"
},
"createTransferInstrumentUSD" : {
"$ref" : "#/components/examples/post-transferInstruments-createTransferInstrumentUSD-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransferInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transferInstruments/{id}" : {
"delete" : {
"tags" : [
"Transfer instruments"
],
"summary" : "Delete a transfer instrument",
"description" : "Deletes a transfer instrument.",
"x-addedInVersion" : "1",
"operationId" : "delete-transferInstruments-id",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 11,
"x-methodName" : "deleteTransferInstrument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the transfer instrument to be deleted.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VoidResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"get" : {
"tags" : [
"Transfer instruments"
],
"summary" : "Get a transfer instrument",
"description" : "Returns the details of a transfer instrument.",
"x-addedInVersion" : "1",
"operationId" : "get-transferInstruments-id",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 9,
"x-methodName" : "getTransferInstrument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the transfer instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-transferInstruments-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransferInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"tags" : [
"Transfer instruments"
],
"summary" : "Update a transfer instrument",
"description" : "Updates a transfer instrument.",
"x-addedInVersion" : "1",
"operationId" : "patch-transferInstruments-id",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 10,
"x-methodName" : "updateTransferInstrument",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrumentInfo"
}
}
}
},
"parameters" : [
{
"description" : "The unique identifier of the transfer instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
}
},
"components" : {
"schemas" : {
"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" : [
"adyenCapital",
"adyenForPlatformsAdvanced",
"adyenForPlatformsManage",
"adyenIssuing"
],
"type" : "string"
}
}
},
"Address" : {
"properties" : {
"city" : {
"description" : "The name of the city. Required if `stateOrProvince` is provided.\n\nIf you specify the city, you must also send `postalCode` and `street`.",
"type" : "string"
},
"country" : {
"description" : "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.",
"type" : "string"
},
"postalCode" : {
"description" : "Postal code. Required if `stateOrProvince` and/or `city` is provided.",
"type" : "string"
},
"stateOrProvince" : {
"description" : "The two-letter ISO 3166-2 state or province code. For example, **CA** in the US. \n\nIf you specify the state or province, you must also send `city`, `postalCode`, and `street`.",
"type" : "string"
},
"street" : {
"description" : "The name of the street, and the house or building number. Required if `stateOrProvince` and/or `city` is provided.",
"type" : "string"
},
"street2" : {
"description" : "The apartment, unit, or suite number.",
"type" : "string"
}
},
"required" : [
"country"
]
},
"Amount" : {
"properties" : {
"currency" : {
"description" : "The type of currency. Must be EUR (or EUR equivalent)",
"type" : "string"
},
"value" : {
"description" : "Total value of amount. Must be >= 0",
"format" : "int64",
"type" : "integer"
}
}
},
"Attachment" : {
"properties" : {
"content" : {
"description" : "The document in Base64-encoded string format.",
"format" : "byte",
"type" : "string"
},
"contentType" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The file format.\n\n Possible values: **application/pdf**, **image/jpg**, **image/jpeg**, **image/png**. ",
"type" : "string"
},
"filename" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The name of the file including the file extension.",
"type" : "string"
},
"pageName" : {
"x-addedInVersion" : "2",
"description" : "The name of the file including the file extension.",
"type" : "string"
},
"pageType" : {
"description" : "Specifies which side of the ID card is uploaded.\n\n* When `type` is **driversLicense** or **identityCard**, set this to **front** or **back**.\n\n* When omitted, we infer the page number based on the order of attachments.",
"type" : "string"
}
},
"required" : [
"content"
]
},
"BankAccountInfo" : {
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n\n When this is provided, the `branchCode` is also required.",
"type" : "string"
},
"accountType" : {
"deprecated" : true,
"x-deprecatedInVersion" : "2",
"description" : "The type of bank account.",
"type" : "string"
},
"bankBicSwift" : {
"description" : "The bank's BIC or SWIFT code.",
"type" : "string"
},
"bankCity" : {
"description" : "The city where the bank is located.",
"type" : "string"
},
"bankCode" : {
"description" : "The bank code of the banking institution with which the bank account is registered.",
"type" : "string"
},
"bankName" : {
"description" : "The name of the banking institution where the bank account is held.",
"type" : "string"
},
"branchCode" : {
"description" : "The branch code of the branch under which the bank account is registered.\n\nRequired when you provide an `accountNumber`.\n\n In the following countries, this value corresponds to:\n\n\n* United States: routing number\n* United Kingdom: sort code\n* Germany: Bankleitzahl",
"type" : "string"
},
"checkCode" : {
"description" : "The check code of the bank account.",
"type" : "string"
},
"countryCode" : {
"description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the bank account is registered. For example, **NL**.",
"type" : "string"
},
"currencyCode" : {
"description" : "The account's three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **EUR**.",
"type" : "string"
},
"iban" : {
"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" : {
"description" : "The individual's date of birth, in YYYY-MM-DD format.",
"type" : "string"
}
}
},
"BusinessLine" : {
"properties" : {
"capability" : {
"description" : "The capability for which you are creating the business line. For example, **receivePayments**.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the business line.",
"readOnly" : true,
"type" : "string"
},
"industryCode" : {
"description" : "A code that represents the industry of the legal entity. For example, **4431A** for computer software stores.",
"type" : "string"
},
"legalEntityId" : {
"description" : "Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.",
"type" : "string"
},
"salesChannels" : {
"description" : "A list of channels where goods or services are sold. You cannot combine point of sale and ecommerce in one business line.\n\nPossible values and combinations:\n\n- For point of sale: **pos** and **posMoto**\n\n- For ecommerce: **eCommerce** and **ecomMoto**\n\n- For Pay by Link: **payByLink**\n\nRequired only in combination with the `capability` to **receivePayments** or **receiveFromPlatformPayments**.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"sourceOfFunds" : {
"description" : "Contains information about the source of your user's funds. Required only for the `capability` to **issueBankAccount**.",
"$ref" : "#/components/schemas/SourceOfFunds"
},
"webData" : {
"description" : "List of website URLs where your user's goods or services are sold. When this is required for a capability but your user does not have an online presence, provide the reason in the `webDataExemption` object.",
"items" : {
"$ref" : "#/components/schemas/WebData"
},
"type" : "array"
},
"webDataExemption" : {
"description" : "The reason why the web data is not provided.",
"$ref" : "#/components/schemas/WebDataExemption"
}
},
"required" : [
"capability",
"industryCode",
"legalEntityId",
"id"
]
},
"BusinessLineInfo" : {
"properties" : {
"capability" : {
"description" : "The capability for which you are creating the business line. For example, **receivePayments**.",
"type" : "string"
},
"industryCode" : {
"description" : "A code that represents the industry of the legal entity. For example, **4431A** for computer software stores.",
"type" : "string"
},
"legalEntityId" : {
"description" : "Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.",
"type" : "string"
},
"salesChannels" : {
"description" : "A list of channels where goods or services are sold. You cannot combine point of sale and ecommerce in one business line.\n\nPossible values and combinations:\n\n- For point of sale: **pos** and **posMoto**\n\n- For ecommerce: **eCommerce** and **ecomMoto**\n\n- For Pay by Link: **payByLink**\n\nRequired only in combination with the `capability` to **receivePayments** or **receiveFromPlatformPayments**.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"sourceOfFunds" : {
"description" : "Contains information about the source of your user's funds. Required only for the `capability` to **issueBankAccount**.",
"$ref" : "#/components/schemas/SourceOfFunds"
},
"webData" : {
"description" : "List of website URLs where your user's goods or services are sold. When this is required for a capability but your user does not have an online presence, provide the reason in the `webDataExemption` object.",
"items" : {
"$ref" : "#/components/schemas/WebData"
},
"type" : "array"
},
"webDataExemption" : {
"description" : "The reason why the web data is not provided.",
"$ref" : "#/components/schemas/WebDataExemption"
}
},
"required" : [
"capability",
"industryCode",
"legalEntityId"
]
},
"BusinessLineInfoUpdate" : {
"properties" : {
"capability" : {
"description" : "The capability for which you are creating the business line. For example, **receivePayments**.",
"type" : "string"
},
"industryCode" : {
"description" : "A code that represents the industry of your legal entity. For example, **4431A** for computer software stores.",
"type" : "string"
},
"legalEntityId" : {
"description" : "Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.",
"type" : "string"
},
"salesChannels" : {
"description" : "A list of channels where goods or services are sold. You cannot combine point of sale and ecommerce in one business line.\n\nPossible values and combinations:\n\n- For point of sale: **pos** and **posMoto**\n\n- For ecommerce: **eCommerce** and **ecomMoto**\n\n- For Pay by Link: **payByLink**\n\nRequired only in combination with the `capability` to **receivePayments** or **receiveFromPlatformPayments**.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"sourceOfFunds" : {
"description" : "Contains information about the source of your user's funds. Required only for the `capability` to **issueBankAccount**.",
"$ref" : "#/components/schemas/SourceOfFunds"
},
"webData" : {
"description" : "List of website URLs where your user's goods or services are sold. When this is required for a capability but your user does not have an online presence, provide the reason in the `webDataExemption` object.",
"items" : {
"$ref" : "#/components/schemas/WebData"
},
"type" : "array"
},
"webDataExemption" : {
"description" : "The reason why the web data is not provided.",
"$ref" : "#/components/schemas/WebDataExemption"
}
}
},
"BusinessLines" : {
"properties" : {
"businessLines" : {
"description" : "List of business lines.",
"items" : {
"$ref" : "#/components/schemas/BusinessLine"
},
"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" : [
"adyenCapital",
"adyenForPlatformsAdvanced",
"adyenForPlatformsManage",
"adyenIssuing"
],
"type" : "string"
},
"type" : "array"
}
}
},
"CapabilityProblem" : {
"properties" : {
"entity" : {
"$ref" : "#/components/schemas/CapabilityProblemEntity"
},
"verificationErrors" : {
"items" : {
"$ref" : "#/components/schemas/VerificationError"
},
"type" : "array"
}
}
},
"CapabilityProblemEntity" : {
"properties" : {
"id" : {
"type" : "string"
},
"owner" : {
"$ref" : "#/components/schemas/CapabilityProblemEntity-recursive"
},
"type" : {
"enum" : [
"BankAccount",
"Document",
"LegalEntity"
],
"type" : "string"
}
}
},
"CapabilityProblemEntity-recursive" : {
"properties" : {
"id" : {
"type" : "string"
},
"type" : {
"enum" : [
"BankAccount",
"Document",
"LegalEntity"
],
"type" : "string"
}
},
"required" : [
]
},
"CapabilitySettings" : {
"properties" : {
"amountPerIndustry" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/Amount"
},
"type" : "object"
},
"authorizedCardUsers" : {
"type" : "boolean"
},
"fundingSource" : {
"items" : {
"enum" : [
"credit",
"debit",
"prepaid"
],
"type" : "string"
},
"type" : "array"
},
"interval" : {
"enum" : [
"daily",
"monthly",
"weekly"
],
"type" : "string"
},
"maxAmount" : {
"$ref" : "#/components/schemas/Amount"
}
}
},
"Document" : {
"properties" : {
"attachment" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"x-deprecatedMessage" : "Use the `attachments` array instead.",
"description" : "Object that contains the document.",
"$ref" : "#/components/schemas/Attachment"
},
"attachments" : {
"description" : "Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.",
"items" : {
"$ref" : "#/components/schemas/Attachment"
},
"type" : "array"
},
"creationDate" : {
"description" : "The creation date of the document.",
"format" : "date-time",
"readOnly" : true,
"type" : "string"
},
"description" : {
"description" : "Your description for the document.",
"type" : "string"
},
"expiryDate" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The expiry date of the document, in YYYY-MM-DD format.",
"type" : "string"
},
"fileName" : {
"description" : "The filename of the document.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the document.",
"readOnly" : true,
"type" : "string"
},
"issuerCountry" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.",
"type" : "string"
},
"issuerState" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The state or province where the document was issued (AU only).",
"type" : "string"
},
"modificationDate" : {
"description" : "The modification date of the document.",
"format" : "date-time",
"readOnly" : true,
"type" : "string"
},
"number" : {
"description" : "The number in the document.",
"type" : "string"
},
"owner" : {
"description" : "Contains information about the resource that owns the document.",
"$ref" : "#/components/schemas/OwnerEntity"
},
"type" : {
"description" : "Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.\n\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**. \n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\n\n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).",
"enum" : [
"bankStatement",
"driversLicense",
"identityCard",
"nationalIdNumber",
"passport",
"proofOfAddress",
"proofOfNationalIdNumber",
"proofOfResidency",
"registrationDocument",
"vatDocument",
"proofOfOrganizationTaxInfo",
"proofOfIndustry",
"constitutionalDocument"
],
"type" : "string"
}
},
"required" : [
"type",
"description",
"owner",
"attachments",
"id"
]
},
"DocumentReference" : {
"properties" : {
"active" : {
"description" : "Identifies whether the document is active and used for checks.",
"type" : "boolean"
},
"fileName" : {
"description" : "Document name.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the resource.",
"type" : "string"
}
}
},
"EntityReference" : {
"properties" : {
"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" : [
"adyenCapital",
"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" : [
"adyenCapital",
"adyenForPlatformsAdvanced",
"adyenForPlatformsManage",
"adyenIssuing"
],
"type" : "string"
}
}
},
"IdentificationData" : {
"properties" : {
"cardNumber" : {
"description" : "The card number of the document that was issued (AU only).",
"type" : "string"
},
"expiryDate" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The expiry date of the document, in YYYY-MM-DD format.",
"type" : "string"
},
"issuerCountry" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.",
"type" : "string"
},
"issuerState" : {
"description" : "The state or province where the document was issued (AU only).",
"type" : "string"
},
"nationalIdExempt" : {
"description" : "Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.",
"type" : "boolean"
},
"number" : {
"description" : "The number in the document.",
"type" : "string"
},
"type" : {
"description" : "Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.\n\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**. \n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\n\n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).",
"enum" : [
"bankStatement",
"driversLicense",
"identityCard",
"nationalIdNumber",
"passport",
"proofOfAddress",
"proofOfNationalIdNumber",
"proofOfResidency",
"registrationDocument",
"vatDocument",
"proofOfOrganizationTaxInfo",
"proofOfIndustry",
"constitutionalDocument"
],
"type" : "string"
}
},
"required" : [
"type"
]
},
"Individual" : {
"properties" : {
"birthData" : {
"description" : "The individual's birth information.",
"$ref" : "#/components/schemas/BirthData"
},
"email" : {
"description" : "The email address of the legal entity.",
"type" : "string"
},
"identificationData" : {
"description" : "Information about the individual's identification document.",
"$ref" : "#/components/schemas/IdentificationData"
},
"name" : {
"description" : "The individual's name.",
"$ref" : "#/components/schemas/Name"
},
"nationality" : {
"description" : "The individual's nationality.",
"type" : "string"
},
"phone" : {
"description" : "The phone number of the legal entity.",
"$ref" : "#/components/schemas/PhoneNumber"
},
"residentialAddress" : {
"description" : "The residential address of the individual.",
"$ref" : "#/components/schemas/Address"
},
"taxInformation" : {
"x-addedInVersion" : "2",
"description" : "The tax information of the individual.",
"items" : {
"$ref" : "#/components/schemas/TaxInformation"
},
"type" : "array"
},
"webData" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The website and app URL of the legal entity.",
"$ref" : "#/components/schemas/WebData"
}
},
"required" : [
"name",
"residentialAddress"
]
},
"LegalEntity" : {
"properties" : {
"capabilities" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/LegalEntityCapability"
},
"description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.",
"readOnly" : true,
"type" : "object"
},
"documentDetails" : {
"x-addedInVersion" : "2",
"description" : "List of documents uploaded for the legal entity.",
"items" : {
"$ref" : "#/components/schemas/DocumentReference"
},
"type" : "array"
},
"documents" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"x-deprecatedMessage" : "Use the `documentDetails` array instead.",
"description" : "List of documents uploaded for the legal entity.",
"items" : {
"$ref" : "#/components/schemas/EntityReference"
},
"type" : "array"
},
"entityAssociations" : {
"description" : "List of legal entities associated with the current legal entity.\nFor example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.",
"items" : {
"$ref" : "#/components/schemas/LegalEntityAssociation"
},
"type" : "array"
},
"id" : {
"description" : "The unique identifier of the legal entity.",
"readOnly" : true,
"type" : "string"
},
"individual" : {
"description" : "Information about the individual. Required if `type` is **individual**.",
"$ref" : "#/components/schemas/Individual"
},
"organization" : {
"description" : "Information about the organization. Required if `type` is **organization**.",
"$ref" : "#/components/schemas/Organization"
},
"reference" : {
"description" : "Your reference for the legal entity, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"soleProprietorship" : {
"x-addedInVersion" : "2",
"description" : "Information about the sole proprietorship. Required if `type` is **soleProprietorship**.",
"$ref" : "#/components/schemas/SoleProprietorship"
},
"transferInstruments" : {
"description" : "List of transfer instruments owned by the legal entity.",
"items" : {
"$ref" : "#/components/schemas/TransferInstrumentReference"
},
"type" : "array"
},
"type" : {
"description" : "The type of legal entity.\n\n Possible values: **individual**, **organization**, or **soleProprietorship**.",
"enum" : [
"individual",
"organization",
"soleProprietorship",
"trust",
"unincorporatedPartnership"
],
"type" : "string"
}
},
"required" : [
"id"
]
},
"LegalEntityAssociation" : {
"properties" : {
"associatorId" : {
"description" : "The unique identifier of another legal entity with which the `legalEntityId` is associated. When the `legalEntityId` is associated to legal entities other than the current one, the response returns all the associations.",
"readOnly" : true,
"type" : "string"
},
"entityType" : {
"description" : "The legal entity type of associated legal entity. \n\nFor example, **organization**, **soleProprietorship** or **individual**. ",
"readOnly" : true,
"type" : "string"
},
"jobTitle" : {
"description" : "The individual's job title if the `type` is **uboThroughControl** or **signatory**.",
"type" : "string"
},
"legalEntityId" : {
"description" : "The unique identifier of the associated [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id).",
"type" : "string"
},
"name" : {
"description" : "The name of the associated [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id).\n\n- For **individual**, `name.firstName` and `name.lastName`.\n- For **organization**, `legalName`.\n- For **soleProprietorship**, `name`.",
"readOnly" : true,
"type" : "string"
},
"type" : {
"description" : "Defines the relationship of the legal entity to the current legal entity. \n\nFor example, **uboThroughOwnership**, **uboThroughControl**, **signatory**, or **soleProprietorship**. ",
"enum" : [
"pciSignatory",
"signatory",
"soleProprietorship",
"uboThroughControl",
"uboThroughOwnership"
],
"type" : "string"
}
},
"required" : [
"legalEntityId",
"type"
]
},
"LegalEntityCapability" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful ",
"readOnly" : true,
"type" : "boolean"
},
"allowedLevel" : {
"description" : "The capability level that is allowed for the legal entity.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.",
"enum" : [
"high",
"low",
"medium",
"notApplicable"
],
"readOnly" : true,
"type" : "string"
},
"allowedSettings" : {
"description" : "The settings that were allowed for the Legal Entity.",
"readOnly" : true,
"$ref" : "#/components/schemas/CapabilitySettings"
},
"problems" : {
"description" : "Contains verification errors and the actions that you can take to resolve them.",
"items" : {
"$ref" : "#/components/schemas/CapabilityProblem"
},
"readOnly" : true,
"type" : "array"
},
"requested" : {
"description" : "Indicates whether the capability is requested. To check whether the Legal Entity is permitted to use the capability, ",
"readOnly" : true,
"type" : "boolean"
},
"requestedLevel" : {
"description" : "The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.",
"enum" : [
"high",
"low",
"medium",
"notApplicable"
],
"readOnly" : true,
"type" : "string"
},
"requestedSettings" : {
"description" : "The settings that are requested for the Legal Entity.",
"readOnly" : true,
"$ref" : "#/components/schemas/CapabilitySettings"
},
"transferInstruments" : {
"description" : "Capability status for transfer instruments associated with legal entity",
"items" : {
"$ref" : "#/components/schemas/SupportingEntityCapability"
},
"readOnly" : true,
"type" : "array"
},
"verificationStatus" : {
"description" : "The status of the verification checks for the capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"readOnly" : true,
"type" : "string"
}
}
},
"LegalEntityInfo" : {
"properties" : {
"capabilities" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/LegalEntityCapability"
},
"description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.",
"readOnly" : true,
"type" : "object"
},
"entityAssociations" : {
"description" : "List of legal entities associated with the current legal entity.\nFor example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.",
"items" : {
"$ref" : "#/components/schemas/LegalEntityAssociation"
},
"type" : "array"
},
"individual" : {
"description" : "Information about the individual. Required if `type` is **individual**.",
"$ref" : "#/components/schemas/Individual"
},
"organization" : {
"description" : "Information about the organization. Required if `type` is **organization**.",
"$ref" : "#/components/schemas/Organization"
},
"reference" : {
"description" : "Your reference for the legal entity, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"soleProprietorship" : {
"x-addedInVersion" : "2",
"description" : "Information about the sole proprietorship. Required if `type` is **soleProprietorship**.",
"$ref" : "#/components/schemas/SoleProprietorship"
},
"type" : {
"description" : "The type of legal entity.\n\n Possible values: **individual**, **organization**, or **soleProprietorship**.",
"enum" : [
"individual",
"organization",
"soleProprietorship",
"trust",
"unincorporatedPartnership"
],
"type" : "string"
}
}
},
"LegalEntityInfoRequiredType" : {
"properties" : {
"capabilities" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/LegalEntityCapability"
},
"description" : "Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.",
"readOnly" : true,
"type" : "object"
},
"entityAssociations" : {
"description" : "List of legal entities associated with the current legal entity.\nFor example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.",
"items" : {
"$ref" : "#/components/schemas/LegalEntityAssociation"
},
"type" : "array"
},
"individual" : {
"description" : "Information about the individual. Required if `type` is **individual**.",
"$ref" : "#/components/schemas/Individual"
},
"organization" : {
"description" : "Information about the organization. Required if `type` is **organization**.",
"$ref" : "#/components/schemas/Organization"
},
"reference" : {
"description" : "Your reference for the legal entity, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"soleProprietorship" : {
"x-addedInVersion" : "2",
"description" : "Information about the sole proprietorship. Required if `type` is **soleProprietorship**.",
"$ref" : "#/components/schemas/SoleProprietorship"
},
"type" : {
"description" : "The type of legal entity.\n\n Possible values: **individual**, **organization**, or **soleProprietorship**.",
"enum" : [
"individual",
"organization",
"soleProprietorship",
"trust",
"unincorporatedPartnership"
],
"type" : "string"
}
},
"required" : [
"type"
]
},
"Name" : {
"properties" : {
"firstName" : {
"description" : "The individual's first name.",
"type" : "string"
},
"infix" : {
"description" : "The infix in the individual's name, if any.",
"type" : "string"
},
"lastName" : {
"description" : "The individual's last name.",
"type" : "string"
}
},
"required" : [
"firstName",
"lastName"
]
},
"OnboardingLink" : {
"properties" : {
"url" : {
"description" : "The URL of the hosted onboarding page where you need to redirect your user. This URL expires after 4 minutes and can only be used once.\n\nIf the link expires, you need to create a new link.",
"type" : "string"
}
}
},
"OnboardingLinkInfo" : {
"properties" : {
"locale" : {
"description" : "The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. See [possible values](https://docs.adyen.com/marketplaces-and-platforms/onboarding/hosted#supported-languages). \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.",
"type" : "string"
},
"redirectUrl" : {
"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"
}
}
},
"OnboardingTheme" : {
"properties" : {
"createdAt" : {
"description" : "The creation date of the theme.",
"format" : "date-time",
"type" : "string"
},
"description" : {
"description" : "The description of the theme.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the theme.",
"type" : "string"
},
"properties" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "The properties of the theme.",
"type" : "object"
},
"updatedAt" : {
"description" : "The date when the theme was last updated.",
"format" : "date-time",
"type" : "string"
}
},
"required" : [
"properties",
"id",
"createdAt"
]
},
"OnboardingThemes" : {
"properties" : {
"next" : {
"description" : "The next page. Only present if there is a next page.",
"type" : "string"
},
"previous" : {
"description" : "The previous page. Only present if there is a previous page.",
"type" : "string"
},
"themes" : {
"description" : "List of onboarding themes.",
"items" : {
"$ref" : "#/components/schemas/OnboardingTheme"
},
"type" : "array"
}
},
"required" : [
"themes"
]
},
"Organization" : {
"properties" : {
"description" : {
"description" : "Your description for the organization.",
"type" : "string"
},
"doingBusinessAs" : {
"description" : "The organization's trading name, if different from the registered legal name.",
"type" : "string"
},
"email" : {
"description" : "The email address of the legal entity.",
"type" : "string"
},
"legalName" : {
"description" : "The organization's legal name.",
"type" : "string"
},
"phone" : {
"description" : "The phone number of the legal entity.",
"$ref" : "#/components/schemas/PhoneNumber"
},
"principalPlaceOfBusiness" : {
"description" : "The address where the organization operates from. Provide this if the principal place of business is different from the `registeredAddress`.",
"$ref" : "#/components/schemas/Address"
},
"registeredAddress" : {
"description" : "The address of the organization registered at their registrar (such as the Chamber of Commerce).",
"$ref" : "#/components/schemas/Address"
},
"registrationNumber" : {
"description" : "The organization's registration number.",
"type" : "string"
},
"stockData" : {
"description" : "Information about the organization's publicly traded stock. Provide this object only if `type` is **listedPublicCompany**.",
"$ref" : "#/components/schemas/StockData"
},
"taxInformation" : {
"x-addedInVersion" : "2",
"description" : "The tax information of the organization.",
"items" : {
"$ref" : "#/components/schemas/TaxInformation"
},
"type" : "array"
},
"taxReportingClassification" : {
"x-addedInVersion" : "2",
"description" : "The tax reporting classification (FATCA/CRS self-certification) of the organization.",
"$ref" : "#/components/schemas/TaxReportingClassification"
},
"type" : {
"description" : "Type of organization. \n\nPossible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**, **nonProfit**, **partnershipIncorporated**, **privateCompany**.",
"enum" : [
"associationIncorporated",
"governmentalOrganization",
"listedPublicCompany",
"nonProfit",
"partnershipIncorporated",
"privateCompany"
],
"type" : "string"
},
"vatAbsenceReason" : {
"x-addedInVersion" : "2",
"description" : "The reason the organization has not provided a VAT number.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.",
"enum" : [
"industryExemption",
"belowTaxThreshold"
],
"type" : "string"
},
"vatNumber" : {
"x-addedInVersion" : "2",
"description" : "The organization's VAT number.",
"type" : "string"
},
"webData" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
"description" : "The website and app URL of the legal entity.",
"$ref" : "#/components/schemas/WebData"
}
},
"required" : [
"legalName",
"registeredAddress"
]
},
"OwnerEntity" : {
"properties" : {
"id" : {
"description" : "Unique identifier of the resource that owns the document. For `type` **legalEntity**, this value is the unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id). For `type` **bankAccount**, this value is the unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).",
"type" : "string"
},
"type" : {
"description" : "Type of resource that owns the document.\n\nPossible values: **legalEntity**, **bankAccount**.",
"type" : "string"
}
},
"required" : [
"id",
"type"
]
},
"PhoneNumber" : {
"properties" : {
"number" : {
"description" : "The full phone number, including the country code. For example, **+3112345678**.",
"type" : "string"
},
"type" : {
"description" : "The type of phone number.\n Possible values: **mobile**, **landline**, **sip**, **fax.** ",
"type" : "string"
}
},
"required" : [
"number"
]
},
"RemediatingAction" : {
"properties" : {
"code" : {
"type" : "string"
},
"message" : {
"type" : "string"
}
}
},
"ServiceError" : {
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
"type" : "string"
},
"errorType" : {
"description" : "The category of the error.",
"type" : "string"
},
"message" : {
"description" : "A short explanation of the issue.",
"type" : "string"
},
"pspReference" : {
"description" : "The PSP reference of the payment.",
"type" : "string"
},
"status" : {
"description" : "The HTTP response status.",
"format" : "int32",
"type" : "integer"
}
}
},
"SoleProprietorship" : {
"properties" : {
"countryOfGoverningLaw" : {
"description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.",
"type" : "string"
},
"doingBusinessAs" : {
"description" : "The registered name, if different from the `name`.",
"type" : "string"
},
"name" : {
"description" : "The legal name.",
"type" : "string"
},
"principalPlaceOfBusiness" : {
"description" : "The business address. Required if the principal place of business is different from the `registeredAddress`.",
"$ref" : "#/components/schemas/Address"
},
"registeredAddress" : {
"description" : "The address registered at the registrar, such as the Chamber of Commerce.",
"$ref" : "#/components/schemas/Address"
},
"registrationNumber" : {
"description" : "The registration number.",
"type" : "string"
},
"vatAbsenceReason" : {
"description" : "The reason for not providing a VAT number.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.",
"enum" : [
"industryExemption",
"belowTaxThreshold"
],
"type" : "string"
},
"vatNumber" : {
"description" : "The VAT number.",
"type" : "string"
}
},
"required" : [
"name",
"countryOfGoverningLaw",
"registeredAddress"
]
},
"SourceOfFunds" : {
"properties" : {
"acquiringBusinessLineId" : {
"description" : "The unique identifier of the business line that will be the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.",
"type" : "string"
},
"adyenProcessedFunds" : {
"description" : "Indicates whether the funds are coming from transactions processed by Adyen. If **false**, a `description` is required.",
"type" : "boolean"
},
"description" : {
"description" : "Text describing the source of funds. For example, for `type` **business**, provide a description of the business. Required when `adyenProcessedFunds` is **false**.",
"type" : "string"
},
"type" : {
"description" : "The type of the source of funds. Possible value: **business**.",
"enum" : [
"business"
],
"type" : "string"
}
}
},
"StockData" : {
"properties" : {
"marketIdentifier" : {
"description" : "The four-digit [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) of the stock market where the organization's stocks are traded.",
"type" : "string"
},
"stockNumber" : {
"description" : "The 12-digit International Securities Identification Number (ISIN) of the company, without dashes (-).",
"type" : "string"
},
"tickerSymbol" : {
"description" : "The stock ticker symbol.",
"type" : "string"
}
}
},
"SupportingEntityCapability" : {
"properties" : {
"allowed" : {
"description" : "Indicates whether the supporting entity capability is allowed.\n\nIf a supporting entity is allowed but its parent legal entity is not, it means there are other supporting entities that failed validation.\n\n**The allowed supporting entity can still be used**",
"readOnly" : true,
"type" : "boolean"
},
"id" : {
"description" : "Supporting entity reference ",
"readOnly" : true,
"type" : "string"
},
"problems" : {
"description" : "Contains verification errors and the actions that you can take to resolve them.",
"items" : {
"$ref" : "#/components/schemas/CapabilityProblem"
},
"readOnly" : true,
"type" : "array"
},
"requested" : {
"description" : "Indicates whether the supporting entity capability is requested. ",
"readOnly" : true,
"type" : "boolean"
},
"verificationStatus" : {
"description" : "The status of the verification checks for the supporting entity capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"readOnly" : true,
"type" : "string"
}
}
},
"TaxInformation" : {
"properties" : {
"country" : {
"description" : "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.",
"maxLength" : 2,
"minLength" : 2,
"type" : "string"
},
"number" : {
"description" : "The tax ID number (TIN) of the organization or individual.",
"type" : "string"
},
"type" : {
"description" : "The TIN type depending on the country where it was issued. Provide only for countries that have multiple tax IDs, such as Sweden, the UK, or the US. For example, provide **SSN**, **EIN**, or **ITIN** for the US.",
"type" : "string"
}
}
},
"TaxReportingClassification" : {
"properties" : {
"businessType" : {
"description" : "The organization's business type.\n\nPossible values: **other**, **listedPublicCompany**, **subsidiaryOfListedPublicCompany**, **governmentalOrganization**, **internationalOrganization**, **financialInstitution**.",
"enum" : [
"other",
"listedPublicCompany",
"subsidiaryOfListedPublicCompany",
"governmentalOrganization",
"internationalOrganization",
"financialInstitution."
],
"type" : "string"
},
"financialInstitutionNumber" : {
"description" : "The Global Intermediary Identification Number (GIIN) required for FATCA.",
"type" : "string"
},
"mainSourceOfIncome" : {
"description" : "The organization's main source of income.\n\nPossible values: **businessOperation**, **realEstateSales**, **investmentInterestOrRoyalty**, **propertyRental**, **other**.",
"enum" : [
"businessOperation",
"realEstateSales",
"investmentInterestOrRoyalty",
"propertyRental",
"other"
],
"type" : "string"
},
"type" : {
"description" : "The tax reporting classification type.\n\nPossible values: **nonFinancialNonReportable**, **financialNonReportable**, **nonFinancialActive**, **nonFinancialPassive**.",
"enum" : [
"nonFinancialNonReportable",
"financialNonReportable",
"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" : [
"adyenCapital",
"adyenForPlatformsAdvanced",
"adyenForPlatformsManage",
"adyenIssuing"
],
"type" : "string"
}
}
},
"TransferInstrument" : {
"properties" : {
"bankAccount" : {
"description" : "Contains information about the legal entity's bank account.",
"$ref" : "#/components/schemas/BankAccountInfo"
},
"documentDetails" : {
"x-addedInVersion" : "2",
"description" : "List of documents uploaded for the transfer instrument.",
"items" : {
"$ref" : "#/components/schemas/DocumentReference"
},
"type" : "array"
},
"id" : {
"description" : "The unique identifier of the transfer instrument.",
"readOnly" : true,
"type" : "string"
},
"legalEntityId" : {
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the transfer instrument.",
"type" : "string"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible value: **bankAccount**.",
"enum" : [
"bankAccount",
"recurringDetail"
],
"type" : "string"
}
},
"required" : [
"legalEntityId",
"type",
"bankAccount",
"id"
]
},
"TransferInstrumentInfo" : {
"properties" : {
"bankAccount" : {
"description" : "Contains information about the legal entity's bank account.",
"$ref" : "#/components/schemas/BankAccountInfo"
},
"legalEntityId" : {
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the transfer instrument.",
"type" : "string"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible value: **bankAccount**.",
"enum" : [
"bankAccount",
"recurringDetail"
],
"type" : "string"
}
},
"required" : [
"legalEntityId",
"type",
"bankAccount"
]
},
"TransferInstrumentReference" : {
"properties" : {
"accountIdentifier" : {
"description" : "Account identifier",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the resource.",
"type" : "string"
}
}
},
"VerificationError" : {
"properties" : {
"capabilities" : {
"items" : {
"enum" : [
"acceptExternalFunding",
"acceptPspFunding",
"acceptTransactionInRestrictedCountries",
"acceptTransactionInRestrictedCountriesCommercial",
"acceptTransactionInRestrictedCountriesConsumer",
"acceptTransactionInRestrictedIndustries",
"acceptTransactionInRestrictedIndustriesCommercial",
"acceptTransactionInRestrictedIndustriesConsumer",
"acquiring",
"atmWithdrawal",
"atmWithdrawalCommercial",
"atmWithdrawalConsumer",
"atmWithdrawalInRestrictedCountries",
"atmWithdrawalInRestrictedCountriesCommercial",
"atmWithdrawalInRestrictedCountriesConsumer",
"authorisedPaymentInstrumentUser",
"getGrantOffers",
"issueBankAccount",
"issueCard",
"issueCardCommercial",
"issueCardConsumer",
"localAcceptance",
"payout",
"payoutToTransferInstrument",
"processing",
"receiveFromBalanceAccount",
"receiveFromPlatformPayments",
"receiveFromThirdParty",
"receiveFromTransferInstrument",
"receiveGrants",
"receivePayments",
"sendToBalanceAccount",
"sendToThirdParty",
"sendToTransferInstrument",
"thirdPartyFunding",
"useCard",
"useCardCommercial",
"useCardConsumer",
"useCardInRestrictedCountries",
"useCardInRestrictedCountriesCommercial",
"useCardInRestrictedCountriesConsumer",
"useCardInRestrictedIndustries",
"useCardInRestrictedIndustriesCommercial",
"useCardInRestrictedIndustriesConsumer",
"withdrawFromAtm",
"withdrawFromAtmCommercial",
"withdrawFromAtmConsumer",
"withdrawFromAtmInRestrictedCountries",
"withdrawFromAtmInRestrictedCountriesCommercial",
"withdrawFromAtmInRestrictedCountriesConsumer"
],
"type" : "string"
},
"type" : "array"
},
"code" : {
"type" : "string"
},
"entity" : {
"$ref" : "#/components/schemas/CapabilityProblemEntity"
},
"message" : {
"type" : "string"
},
"remediatingActions" : {
"items" : {
"$ref" : "#/components/schemas/RemediatingAction"
},
"type" : "array"
},
"subErrors" : {
"items" : {
"$ref" : "#/components/schemas/VerificationError-recursive"
},
"type" : "array"
},
"type" : {
"enum" : [
"dataMissing",
"invalidInput",
"pendingStatus"
],
"type" : "string"
}
}
},
"VerificationError-recursive" : {
"properties" : {
"capabilities" : {
"items" : {
"enum" : [
"acceptExternalFunding",
"acceptPspFunding",
"acceptTransactionInRestrictedCountries",
"acceptTransactionInRestrictedCountriesCommercial",
"acceptTransactionInRestrictedCountriesConsumer",
"acceptTransactionInRestrictedIndustries",
"acceptTransactionInRestrictedIndustriesCommercial",
"acceptTransactionInRestrictedIndustriesConsumer",
"acquiring",
"atmWithdrawal",
"atmWithdrawalCommercial",
"atmWithdrawalConsumer",
"atmWithdrawalInRestrictedCountries",
"atmWithdrawalInRestrictedCountriesCommercial",
"atmWithdrawalInRestrictedCountriesConsumer",
"authorisedPaymentInstrumentUser",
"getGrantOffers",
"issueBankAccount",
"issueCard",
"issueCardCommercial",
"issueCardConsumer",
"localAcceptance",
"payout",
"payoutToTransferInstrument",
"processing",
"receiveFromBalanceAccount",
"receiveFromPlatformPayments",
"receiveFromThirdParty",
"receiveFromTransferInstrument",
"receiveGrants",
"receivePayments",
"sendToBalanceAccount",
"sendToThirdParty",
"sendToTransferInstrument",
"thirdPartyFunding",
"useCard",
"useCardCommercial",
"useCardConsumer",
"useCardInRestrictedCountries",
"useCardInRestrictedCountriesCommercial",
"useCardInRestrictedCountriesConsumer",
"useCardInRestrictedIndustries",
"useCardInRestrictedIndustriesCommercial",
"useCardInRestrictedIndustriesConsumer",
"withdrawFromAtm",
"withdrawFromAtmCommercial",
"withdrawFromAtmConsumer",
"withdrawFromAtmInRestrictedCountries",
"withdrawFromAtmInRestrictedCountriesCommercial",
"withdrawFromAtmInRestrictedCountriesConsumer"
],
"type" : "string"
},
"type" : "array"
},
"code" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"type" : {
"enum" : [
"dataMissing",
"invalidInput",
"pendingStatus"
],
"type" : "string"
},
"entity" : {
"$ref" : "#/components/schemas/CapabilityProblemEntity"
},
"remediatingActions" : {
"items" : {
"$ref" : "#/components/schemas/RemediatingAction"
},
"type" : "array"
}
},
"required" : [
]
},
"VoidResponse" : {
},
"WebData" : {
"properties" : {
"webAddress" : {
"description" : "The URL of the website or the app store URL.",
"type" : "string"
},
"webAddressId" : {
"description" : "The unique identifier of the web address.",
"readOnly" : true,
"type" : "string"
}
}
},
"WebDataExemption" : {
"properties" : {
"reason" : {
"description" : "The reason why the web data was not provided. Possible value: **noOnlinePresence**.",
"enum" : [
"noOnlinePresence"
],
"type" : "string"
}
}
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
},
"examples" : {
"get-businessLines-id-success-200" : {
"summary" : "Details of a business line",
"description" : "Example response when getting the business line details",
"value" : {
"capability" : "issueBankAccount",
"industryCode" : "4531",
"legalEntityId" : "LE322JV223222F5GV2LKZ8DFZ",
"sourceOfFunds" : {
"adyenProcessedFunds" : false,
"description" : "Funds from my flower shop business",
"type" : "business"
},
"webData" : [
{
"webAddress" : "https://www.adyen.com",
"webAddressId" : "SE322JV223222J5H8V87B3DHN"
}
],
"id" : "SE322KH223222F5GV2SQ924F6"
}
},
"get-documents-id-success-200" : {
"summary" : "Details of a document",
"description" : "Example response when getting document details",
"value" : {
"type" : "registrationDocument",
"attachments" : [
{
"content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...=="
}
],
"description" : "Registration doc for Example Company",
"fileName" : "Registration doc for Example Company",
"owner" : {
"id" : "LE322KH223222D5GG4C9J83RN",
"type" : "legalEntity"
},
"id" : "SE322JV223222F5GV2N9L8GDK"
}
},
"get-legalEntities-id-businessLines-success-200" : {
"summary" : "List of business lines for a legal entity",
"description" : "Example response when getting the list of business lines for a legal entity",
"value" : {
"businessLines" : [
{
"capability" : "issueBankAccount",
"industryCode" : "55",
"legalEntityId" : "LE322KH223222F5GVGMLF3WBL",
"sourceOfFunds" : {
"adyenProcessedFunds" : false,
"description" : "Funds from my flower shop business",
"type" : "business"
},
"webData" : [
{
"webAddress" : "https://www.adyen.com",
"webAddressId" : "SE577HA334222K5H8V87B3BPU"
}
],
"id" : "SE322JV223222F5GVGMLNB83F"
},
{
"capability" : "receivePayments",
"industryCode" : "339E",
"legalEntityId" : "LE322KH223222F5GVGMLF3WBL",
"salesChannels" : [
"eCommerce",
"ecomMoto"
],
"webData" : [
{
"webAddress" : "https://yoururl.com",
"webAddressId" : "SE616CG45905K5H&M90J8BLM"
}
],
"id" : "SE322JV223222F5GVGPNRB9GJ"
}
]
}
},
"get-legalEntities-id-success-200" : {
"summary" : "Details of a legal entity",
"description" : "Example response when getting the details of a legal entity",
"value" : {
"capabilities" : {
"sendToTransferInstrument" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
},
"receivePayments" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
},
"sendToBalanceAccount" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
},
"receiveFromPlatformPayments" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
},
"receiveFromBalanceAccount" : {
"allowed" : false,
"requested" : true,
"verificationStatus" : "pending"
}
},
"individual" : {
"email" : "s.hopper@example.com",
"birthData" : {
"dateOfBirth" : "1990-06-21"
},
"name" : {
"firstName" : "Simone",
"lastName" : "Hopper"
},
"residentialAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50",
"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",
"value" : {
"description" : "Light colors theme",
"properties" : {
"privacyStatementPage" : "https://www.adyen.com/legal/terms-and-conditions",
"supportPage" : "https://www.adyen.com/contact",
"logo" : "ONBA422JV223222D5FWC4TK25S3DQW",
"pageTitle" : "Example onboarding light colors",
"backgroundColor" : "#FFFFFF",
"faqPage" : "https://docs.adyen.com/hosted-onboarding-faqs",
"backgroundImage" : "ONBA422JV223222D5G82M96F6P2VTV",
"pageLayout" : "withBackground"
},
"createdAt" : "2022-06-22T00:00:00+02:00",
"id" : "ONBT422KH223222D5G82M968PB46HR",
"updatedAt" : "2022-08-25T00:00:00+02:00"
}
},
"get-themes-success-200" : {
"summary" : "List of hosted onboarding themes for your balance platform",
"description" : "Example response when getting the list of hosted onboarding themes",
"value" : {
"themes" : [
{
"description" : "Dark colors theme",
"properties" : {
"supportPage" : "https://www.adyen.com/contact",
"logo" : "ONBA422JV223222D5G8VG2T8JV39GV",
"pageTitle" : "Example onboarding dark colors",
"backgroundColor" : "#000000",
"faqPage" : "https://docs.adyen.com/hosted-onboarding-faqs",
"backgroundImage" : "ONBA422KH223222D5G8VG2TG9S5ZBH",
"pageLayout" : "withBackground"
},
"createdAt" : "2022-01-20T00:00:00+01:00",
"id" : "ONBT422JV223222D5FGJ77B9C52WNN",
"updatedAt" : "2022-08-25T00:00:00+02:00"
},
{
"description" : "Light colors theme",
"properties" : {
"privacyStatementPage" : "https://www.adyen.com/legal/terms-and-conditions",
"supportPage" : "https://www.adyen.com/contact",
"logo" : "ONBA422JV223222D5FWC4TK25S3DQW",
"pageTitle" : "Example onboarding light colors",
"backgroundColor" : "#FFFFFF",
"faqPage" : "https://docs.adyen.com/hosted-onboarding-faqs",
"backgroundImage" : "ONBA422JV223222D5G82M96F6P2VTV",
"pageLayout" : "withBackground"
},
"createdAt" : "2022-06-22T00:00:00+02:00",
"id" : "ONBT422KH223222D5G82M968PB46HR",
"updatedAt" : "2022-08-25T00:00:00+02:00"
}
]
}
},
"get-transferInstruments-id-success-200" : {
"summary" : "Details of a transfer instrument",
"description" : "Example response when getting the details of a transfer instrument",
"value" : {
"bankAccount" : {
"countryCode" : "NL",
"currencyCode" : "EUR",
"iban" : "NL62ABNA0000000123"
},
"legalEntityId" : "LE322JV223222D5G2SPGL59KT",
"type" : "bankAccount",
"id" : "SE322JV223222F5GNXSR89TMW"
}
},
"patch-businessLines-id-updateBusinessLine" : {
"summary" : "Update a business line",
"description" : "Example request for updating the industry code of a business line",
"value" : {
"industryCode" : "55",
"webData" : [
{
"webAddress" : "https://www.example.com"
}
]
}
},
"patch-businessLines-id-updateBusinessLine-200" : {
"summary" : "Business line updated",
"description" : "Example response for updating the industry code of a business line",
"value" : {
"capability" : "issueBankAccount",
"industryCode" : "55",
"legalEntityId" : "LE322KH223222F5GVGMLF3WBL",
"sourceOfFunds" : {
"adyenProcessedFunds" : false,
"description" : "Funds from my flower shop business",
"type" : "business"
},
"webData" : [
{
"webAddress" : "https://www.example.com",
"webAddressId" : "SE890CG45905K5H&M90J7MPY"
}
],
"id" : "SE322JV223222F5GVGMLNB83F"
}
},
"patch-documents-id-updateDocument" : {
"summary" : "Update a document",
"description" : "Example request for updating a document",
"value" : {
"type" : "proofOfIndustry",
"description" : "Proof of industry doc for Example Company"
}
},
"patch-documents-id-uploadDocument-200" : {
"summary" : "Document updated",
"description" : "Example response when a document is updated",
"value" : {
"type" : "proofOfIndustry",
"attachments" : [
{
"content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...=="
}
],
"description" : "Proof of industry for Example Company",
"fileName" : "Proof of industry for Example Company",
"owner" : {
"id" : "LE322KH223222D5GG4C9J83RN",
"type" : "legalEntity"
},
"id" : "SE322JV223222F5GV2N9L8GDK"
}
},
"patch-legalEntities-id-updateLegalEntityOrganization" : {
"summary" : "Add entity associations to an organization",
"description" : "Example request adding entity associations to a legal entity",
"value" : {
"entityAssociations" : [
{
"jobTitle" : "CEO",
"legalEntityId" : "LE322KH223222F5GV2SL953Z3",
"type" : "uboThroughControl"
}
]
}
},
"patch-legalEntities-id-updateLegalEntityOrganization-200" : {
"summary" : "Entity associations added",
"description" : "Example response for adding an entity association to an organization",
"value" : {
"entityAssociations" : [
{
"associatorId" : "LE322KH223222F5GVGNMJ3XC5",
"entityType" : "individual",
"jobTitle" : "CEO",
"legalEntityId" : "LE322KH223222F5GV2SL953Z3",
"name" : "Simone Hopper",
"type" : "uboThroughControl"
}
],
"organization" : {
"email" : "john.doe@adyen.com",
"phone" : {
"countryCode" : "NL",
"number" : "646467363",
"type" : "mobile"
},
"description" : "FinTech",
"doingBusinessAs" : "Adyen BV",
"legalName" : "Adyen BV",
"registeredAddress" : {
"city" : "AMS",
"country" : "NL",
"postalCode" : "1234EE",
"stateOrProvince" : "NH",
"street" : "Simon Carmiggeltstraat 6 - 50"
},
"registrationNumber" : "",
"stockData" : {
"marketIdentifier" : "ADYN",
"stockNumber" : "NL012345ABC4",
"tickerSymbol" : "ADYN.M"
},
"taxExempt" : "false",
"type" : "listedPublicCompany"
},
"type" : "organization",
"id" : "LE322KH223222F5GVGNMJ3XC5"
}
},
"patch-legalEntities-id-updateLegalEntitySoleProp" : {
"summary" : "Add entity associations to a sole proprietorship",
"description" : "Example request adding an entity association to a sole proprietorship",
"value" : {
"entityAssociations" : [
{
"legalEntityId" : "LE00000000000000000000002",
"type" : "soleProprietorship"
}
]
}
},
"patch-legalEntities-id-updateLegalEntitySoleProp-200" : {
"summary" : "Entity association added to a sole proprietorship",
"description" : "Example response for adding an entity association to a sole proprietorship",
"value" : {
"entityAssociations" : [
{
"associatorId" : "LE00000000000000000000001",
"entityType" : "soleProprietorship",
"legalEntityId" : "LE00000000000000000000002",
"type" : "soleProprietorship"
}
],
"individual" : {
"email" : "s.eller@example.com",
"birthData" : {
"dateOfBirth" : "1990-06-21"
},
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"residentialAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
}
},
"type" : "individual",
"id" : "LE00000000000000000000001"
}
},
"post-businessLines-createBusinessLines-businessAccounts" : {
"summary" : "Create a business line for a business account",
"description" : "Example request for creating a business line for a business account",
"value" : {
"capability" : "issueBankAccount",
"industryCode" : "4531",
"webData" : [
{
"webAddress" : "https://www.adyen.com"
}
],
"legalEntityId" : "LE322JV223222D5FZ9N74BSGM",
"sourceOfFunds" : {
"type" : "business",
"adyenProcessedFunds" : false,
"description" : "Funds from my flower shop business"
}
}
},
"post-businessLines-createBusinessLines-businessAccounts-200" : {
"summary" : "Business line created",
"description" : "Example response for creating a business line for a business account",
"value" : {
"capability" : "issueBankAccount",
"industryCode" : "4531",
"legalEntityId" : "LE322JV223222D5FZ9N74BSGM",
"sourceOfFunds" : {
"adyenProcessedFunds" : false,
"description" : "Funds from my flower shop business",
"type" : "business"
},
"webData" : [
{
"webAddress" : "https://www.example.com",
"webAddressId" : "SE966LI345672J5H8V87B3FGH"
}
],
"id" : "SE322JV223222F5GVGMLNB83F"
}
},
"post-documents-uploadDocument" : {
"summary" : "Upload a document",
"description" : "Example request for uploading a document",
"value" : {
"type" : "registrationDocument",
"attachments" : [
{
"content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...=="
}
],
"description" : "Registration doc for Example Company",
"owner" : {
"id" : "LE322KH223222D5GG4C9J83RN",
"type" : "legalEntity"
}
}
},
"post-documents-uploadDocument-200" : {
"summary" : "Document uploaded",
"description" : "Example response when a document is uploaded",
"value" : {
"type" : "registrationDocument",
"attachments" : [
{
"content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...=="
}
],
"description" : "Registration doc for Example Company",
"fileName" : "Registration doc for Example Company",
"owner" : {
"id" : "LE322KH223222D5GG4C9J83RN",
"type" : "legalEntity"
},
"id" : "SE322JV223222F5GV2N9L8GDK"
}
},
"post-legalEntities-createLegalEntityIndividualNL" : {
"summary" : "Create a legal entity for an individual residing in the Netherlands",
"description" : "Example request for creating a legal entity for an individual residing in the Netherlands",
"value" : {
"type" : "individual",
"individual" : {
"residentialAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
},
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"birthData" : {
"dateOfBirth" : "1990-06-21"
},
"email" : "s.eller@example.com"
}
}
},
"post-legalEntities-createLegalEntityIndividualNL-200" : {
"summary" : "Individual legal entity created",
"description" : "Example response for creating a legal entity for an individual residing in the Netherlands",
"value" : {
"individual" : {
"email" : "s.eller@example.com",
"birthData" : {
"dateOfBirth" : "1990-06-21"
},
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"residentialAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
}
},
"type" : "individual",
"id" : "LE322JV223222D5GG42KN6869"
}
},
"post-legalEntities-createLegalEntityIndividualUS" : {
"summary" : "Create a legal entity for an individual residing in the US",
"description" : "Example request for creating a legal entity for an individual residing in the US",
"value" : {
"type" : "individual",
"individual" : {
"residentialAddress" : {
"city" : "New York",
"country" : "US",
"postalCode" : "10003",
"stateOrProvince" : "NY",
"street" : "71 5th Avenue",
"street2" : "11th floor"
},
"phone" : {
"number" : "+14153671502",
"type" : "mobile"
},
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"birthData" : {
"dateOfBirth" : "1990-06-21"
},
"email" : "s.eller@example.com"
}
}
},
"post-legalEntities-createLegalEntityIndividualUS-200" : {
"summary" : "Individual legal entity created",
"description" : "Example response for creating a legal entity for an individual residing in the US",
"value" : {
"individual" : {
"email" : "s.eller@example.com",
"phone" : {
"number" : "+14153671502",
"type" : "mobile"
},
"birthData" : {
"dateOfBirth" : "1990-06-21"
},
"name" : {
"firstName" : "Shelly",
"lastName" : "Eller"
},
"residentialAddress" : {
"city" : "New York",
"country" : "US",
"postalCode" : "10003",
"stateOrProvince" : "NY",
"street" : "71 5th Avenue",
"street2" : "11th floor"
}
},
"type" : "individual",
"id" : "LE322JV223222D5GGMHPC2FPL"
}
},
"post-legalEntities-createLegalEntityOrganizationNL" : {
"summary" : "Create a legal entity for a Dutch organization",
"description" : "Example request for creating a legal entity for an organization operating in the Netherlands",
"value" : {
"type" : "organization",
"organization" : {
"legalName" : "Explorer Company based in NL",
"doingBusinessAs" : "API Company Trading",
"type" : "privateCompany",
"registeredAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
},
"registrationNumber" : "34179503",
"email" : "organization@example.com"
},
"entityAssociations" : [
{
"jobTitle" : "CEO",
"legalEntityId" : "LE322JV223222D5GG42KN6869",
"type" : "signatory"
}
]
}
},
"post-legalEntities-createLegalEntityOrganizationNL-200" : {
"summary" : "Organization legal entity created",
"description" : "Example response for creating a legal entity for an organization operating in the Netherlands",
"value" : {
"organization" : {
"legalName" : "Explorer Company based in NL",
"doingBusinessAs" : "API Company Trading",
"registrationNumber" : "34179503",
"email" : "organization@example.com",
"registeredAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
},
"taxExempt" : false,
"type" : "privateCompany"
},
"type" : "organization",
"id" : "LE322JV223222D5FZ9N74BSGM"
}
},
"post-legalEntities-createLegalEntityOrganizationUS" : {
"summary" : "Create a legal entity for an organization in the US",
"description" : "Example request for creating a legal entity for an organization operating in the US",
"value" : {
"type" : "organization",
"organization" : {
"legalName" : "Explorer Company based in US",
"registrationNumber" : "101002749",
"type" : "privateCompany",
"registeredAddress" : {
"city" : "New York",
"country" : "US",
"postalCode" : "10003",
"stateOrProvince" : "NY",
"street" : "71 5th Avenue",
"street2" : "11th floor"
}
}
}
},
"post-legalEntities-createLegalEntityOrganizationUS-200" : {
"summary" : "Organization legal entity created",
"description" : "Example response for creating a legal entity for an organization operating in the US",
"value" : {
"organization" : {
"legalName" : "Explorer Company based in US",
"registrationNumber" : "101002749",
"registeredAddress" : {
"city" : "New York",
"country" : "US",
"postalCode" : "10003",
"stateOrProvince" : "NY",
"street" : "71 5th Avenue",
"street2" : "11th floor"
},
"taxExempt" : false,
"type" : "privateCompany"
},
"type" : "organization",
"id" : "LE322JV223222D5FZ9N74BSGM"
}
},
"post-legalEntities-createLegalEntitySolePropNL" : {
"summary" : "Create a legal entity for a Dutch sole proprietor",
"description" : "Example request for creating a legal entity for a sole proprietor operating in the Netherlands",
"value" : {
"type" : "soleProprietorship",
"soleProprietorship" : {
"name" : "Shelly Seller Sole Trader",
"countryOfGoverningLaw" : "NL",
"registeredAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
}
}
}
},
"post-legalEntities-createLegalEntitySolePropNL-200" : {
"summary" : "Sole proprietor legal enity created",
"description" : "Example response for creating a legal entity for a sole proprietor operating in the Netherlands",
"value" : {
"type" : "soleProprietorship",
"soleProprietorship" : {
"name" : "Shelly Seller Sole Trader",
"countryOfGoverningLaw" : "NL",
"registeredAddress" : {
"city" : "Amsterdam",
"country" : "NL",
"postalCode" : "1011DJ",
"street" : "Simon Carmiggeltstraat 6 - 50"
}
},
"id" : "LE32272223222D5CGBR254SKT"
}
},
"post-legalEntities-createLegalEntitySolePropUS" : {
"summary" : "Create a legal entity for a sole proprietor in the US",
"description" : "Example request for creating a legal entity for a sole proprietor operating in the US",
"value" : {
"type" : "soleProprietorship",
"soleProprietorship" : {
"name" : "Shelly Eller Sole Trader",
"countryOfGoverningLaw" : "US",
"registeredAddress" : {
"city" : "New York",
"country" : "US",
"postalCode" : "10003",
"stateOrProvince" : "NY",
"street" : "71 5th Avenue",
"street2" : "11th floor"
}
}
}
},
"post-legalEntities-createLegalEntitySolePropUS-200" : {
"summary" : "Sole proprietor legal enity created",
"description" : "Example response for creating a legal entity for a sole proprietor operating in the US",
"value" : {
"type" : "soleProprietorship",
"soleProprietorship" : {
"name" : "Shelly Eller Sole Trader",
"countryOfGoverningLaw" : "US",
"registeredAddress" : {
"city" : "New York",
"country" : "US",
"postalCode" : "10003",
"stateOrProvince" : "NY",
"street" : "71 5th Avenue",
"street2" : "11th floor"
}
},
"id" : "LE32272223222D5CGBR254SKT"
}
},
"post-legalEntities-id-onboardingLinks-createOnboardingLink" : {
"summary" : "Create a hosted onboarding link",
"description" : "Example request for creating a hosted onboarding link",
"value" : {
"redirectUrl" : "https://your.redirect-url.com/",
"locale" : "nl-NL"
}
},
"post-legalEntities-id-onboardingLinks-createOnboardingLink-200" : {
"summary" : "Hosted onboarding link created",
"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",
"value" : {
"legalEntityId" : "LE322KH223222D5GG4C9J83RN",
"type" : "bankAccount",
"bankAccount" : {
"countryCode" : "NL",
"currencyCode" : "EUR",
"iban" : "NL62ABNA0000000123"
}
}
},
"post-transferInstruments-createTransferInstrumentEUR-200" : {
"summary" : "Bank account added",
"description" : "Example response for adding a bank account as a transfer instrument of a legal entity",
"value" : {
"bankAccount" : {
"countryCode" : "NL",
"currencyCode" : "EUR",
"iban" : "NL62ABNA0000000123"
},
"legalEntityId" : "LE322KH223222D5GG4C9J83RN",
"type" : "bankAccount",
"id" : "SE576BH223222F5GJVKHH6BDT"
}
},
"post-transferInstruments-createTransferInstrumentUSD" : {
"summary" : "Add a USD bank account",
"description" : "Example request for creating a transfer instrument for USD",
"value" : {
"legalEntityId" : "LE322JV223222D5GGMHPC2FPL",
"type" : "bankAccount",
"bankAccount" : {
"countryCode" : "US",
"currencyCode" : "USD",
"accountNumber" : "0000000123",
"branchCode" : "121202211",
"accountType" : "checking"
}
}
},
"post-transferInstruments-createTransferInstrumentUSD-200" : {
"summary" : "Bank account added",
"description" : "Example response for adding a bank account as a transfer instrument of a legal entity",
"value" : {
"bankAccount" : {
"accountNumber" : "0000000123",
"accountType" : "checking",
"branchCode" : "121202211",
"countryCode" : "US",
"currencyCode" : "USD"
},
"legalEntityId" : "LE322JV223222D5GGMHPC2FPL",
"type" : "bankAccount",
"id" : "SE322JV223222F5GJVKHH8DTC"
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink