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

spec release

Browse Source
This commit is contained in:
Adyen Automation
2022-12-06 14:54:10 +00:00
parent daff362504
commit da84ef31dd
4 changed files with 1532 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

421
json/LegalEntityService-v1.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Legal Entity Management API",
"description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws12345@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v1/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n",
"x-timestamp" : "2022-11-24T10:16:58Z",
"x-timestamp" : "2022-12-05T17:26:45Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1868,6 +1868,19 @@
"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" : {
@@ -1888,7 +1901,7 @@
"type" : "string"
},
"pageType" : {
"description" : "Specifies which side of the ID card is uploaded.\n\n* When `type` is **driversLicense**, set this to **front** or **back**.\n\n* When omitted, we infer the page number based on the order of attachments.",
"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"
}
},
@@ -1942,11 +1955,7 @@
"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" : {
@@ -2062,6 +2071,89 @@
"businessLines"
]
},
"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" : {
@@ -2257,6 +2349,13 @@
},
"LegalEntity" : {
"properties" : {
"capabilities" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/LegalEntityCapability"
},
"description" : "Overview of capabilities for this legal entity",
"type" : "object"
},
"documents" : {
"deprecated" : true,
"x-deprecatedInVersion" : "1",
@@ -2353,8 +2452,82 @@
"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" : "Overview of capabilities for this legal entity",
"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" : {
@@ -2609,18 +2782,12 @@
"number"
]
},
"RecurringDetail" : {
"RemediatingAction" : {
"properties" : {
"merchantAccount" : {
"description" : "The merchant account used when the payment details were stored.",
"code" : {
"type" : "string"
},
"reference" : {
"description" : "The `recurringDetailReference` returned in the response when the payment details were stored.",
"type" : "string"
},
"shopperReference" : {
"description" : "The unique identifier used when the payment details were stored.",
"message" : {
"type" : "string"
}
}
@@ -2689,6 +2856,38 @@
}
}
},
"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"
}
}
},
"TransferInstrument" : {
"properties" : {
"bankAccount" : {
@@ -2713,12 +2912,8 @@
"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"
},
"recurringDetail" : {
"description" : "Contains information about the legal entity's previously stored payment details. Required when `type` is **recurringDetail**.",
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**, **recurringDetail**.",
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**.",
"enum" : [
"bankAccount",
"recurringDetail"
@@ -2742,12 +2937,8 @@
"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"
},
"recurringDetail" : {
"description" : "Contains information about the legal entity's previously stored payment details. Required when `type` is **recurringDetail**.",
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**, **recurringDetail**.",
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**.",
"enum" : [
"bankAccount",
"recurringDetail"
@@ -2772,6 +2963,184 @@
}
}
},
"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" : {
},

432
json/LegalEntityService-v2.json
View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Legal Entity Management API",
"description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws12345@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n",
"x-timestamp" : "2022-11-25T14:28:20Z",
"x-timestamp" : "2022-12-05T17:26:47Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -1988,6 +1988,19 @@
"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" : {
@@ -2013,7 +2026,7 @@
"type" : "string"
},
"pageType" : {
"description" : "Specifies which side of the ID card is uploaded.\n\n* When `type` is **driversLicense**, set this to **front** or **back**.\n\n* When omitted, we infer the page number based on the order of attachments.",
"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"
}
},
@@ -2069,11 +2082,7 @@
"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" : {
@@ -2086,9 +2095,6 @@
"BusinessLine" : {
"properties" : {
"capability" : {
"deprecated" : true,
"x-deprecatedInVersion" : "2",
"x-deprecatedMessage" : "Use the `service` instead.",
"description" : "The capability for which you are creating the business line. For example, **receivePayments**.",
"type" : "string"
},
@@ -2129,6 +2135,7 @@
}
},
"required" : [
"capability",
"industryCode",
"legalEntityId",
"id"
@@ -2137,9 +2144,6 @@
"BusinessLineInfo" : {
"properties" : {
"capability" : {
"deprecated" : true,
"x-deprecatedInVersion" : "2",
"x-deprecatedMessage" : "Use the `service` instead.",
"description" : "The capability for which you are creating the business line. For example, **receivePayments**.",
"type" : "string"
},
@@ -2175,6 +2179,7 @@
}
},
"required" : [
"capability",
"industryCode",
"legalEntityId"
]
@@ -2182,9 +2187,6 @@
"BusinessLineInfoUpdate" : {
"properties" : {
"capability" : {
"deprecated" : true,
"x-deprecatedInVersion" : "2",
"x-deprecatedMessage" : "Use the `service` instead.",
"description" : "The capability for which you are creating the business line. For example, **receivePayments**.",
"type" : "string"
},
@@ -2234,6 +2236,89 @@
"businessLines"
]
},
"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" : {
@@ -2457,6 +2542,13 @@
},
"LegalEntity" : {
"properties" : {
"capabilities" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/LegalEntityCapability"
},
"description" : "Overview of capabilities for this legal entity",
"type" : "object"
},
"documentDetails" : {
"x-addedInVersion" : "2",
"description" : "List of documents uploaded for the legal entity.",
@@ -2570,8 +2662,82 @@
"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" : "Overview of capabilities for this legal entity",
"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" : {
@@ -2840,18 +3006,12 @@
"number"
]
},
"RecurringDetail" : {
"RemediatingAction" : {
"properties" : {
"merchantAccount" : {
"description" : "The merchant account used when the payment details were stored.",
"code" : {
"type" : "string"
},
"reference" : {
"description" : "The `recurringDetailReference` returned in the response when the payment details were stored.",
"type" : "string"
},
"shopperReference" : {
"description" : "The unique identifier used when the payment details were stored.",
"message" : {
"type" : "string"
}
}
@@ -2965,6 +3125,38 @@
}
}
},
"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" : {
@@ -3047,12 +3239,8 @@
"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"
},
"recurringDetail" : {
"description" : "Contains information about the legal entity's previously stored payment details. Required when `type` is **recurringDetail**.",
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**, **recurringDetail**.",
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**.",
"enum" : [
"bankAccount",
"recurringDetail"
@@ -3076,12 +3264,8 @@
"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"
},
"recurringDetail" : {
"description" : "Contains information about the legal entity's previously stored payment details. Required when `type` is **recurringDetail**.",
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**, **recurringDetail**.",
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**.",
"enum" : [
"bankAccount",
"recurringDetail"
@@ -3106,6 +3290,184 @@
}
}
},
"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" : {
},

393
yaml/LegalEntityService-v1.yaml
View File

@@ -20,7 +20,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n"
x-timestamp: '2022-11-24T10:16:58Z'
x-timestamp: '2022-12-05T17:26:45Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1162,6 +1162,15 @@ components:
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:
@@ -1183,7 +1192,8 @@ components:
description: 'Specifies which side of the ID card is uploaded.
* When `type` is **driversLicense**, set this to **front** or **back**.
* When `type` is **driversLicense** or **identityCard**, set this to **front**
or **back**.
* When omitted, we infer the page number based on the order of attachments.'
@@ -1234,9 +1244,6 @@ components:
description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html)
standard.
type: string
required:
- countryCode
- currencyCode
BirthData:
properties:
dateOfBirth:
@@ -1364,6 +1371,61 @@ components:
type: array
required:
- businessLines
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:
@@ -1539,6 +1601,11 @@ components:
- residentialAddress
LegalEntity:
properties:
capabilities:
additionalProperties:
$ref: '#/components/schemas/LegalEntityCapability'
description: Overview of capabilities for this legal entity
type: object
documents:
deprecated: true
x-deprecatedInVersion: '1'
@@ -1628,8 +1695,97 @@ components:
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.
Possible 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.
Possible 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.
Possible values:
* **pending**: Adyen is running the verification.
* **invalid**: The verification failed. Check if the `errors` array contains
more information.
* **valid**: The verification has been successfully completed.
* **rejected**: Adyen has verified the information, but found reasons
to not allow the capability.
'
readOnly: true
type: string
LegalEntityInfo:
properties:
capabilities:
additionalProperties:
$ref: '#/components/schemas/LegalEntityCapability'
description: Overview of capabilities for this legal entity
type: object
entityAssociations:
description: 'List of legal entities associated with the current legal entity.
@@ -1848,17 +2004,11 @@ components:
required:
- type
- number
RecurringDetail:
RemediatingAction:
properties:
merchantAccount:
description: The merchant account used when the payment details were stored.
code:
type: string
reference:
description: The `recurringDetailReference` returned in the response when
the payment details were stored.
type: string
shopperReference:
description: The unique identifier used when the payment details were stored.
message:
type: string
ServiceError:
properties:
@@ -1912,6 +2062,58 @@ components:
tickerSymbol:
description: The stock ticker symbol.
type: string
SupportingEntityCapability:
properties:
allowed:
description: 'Indicates whether the supporting entity capability is allowed.
If a supporting entity is allowed but its parent legal entity is not,
it means there are other supporting entities that failed validation.
**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.
Possible values:
* **pending**: Adyen is running the verification.
* **invalid**: The verification failed. Check if the `errors` array contains
more information.
* **valid**: The verification has been successfully completed.
* **rejected**: Adyen has verified the information, but found reasons
to not allow the capability.
'
readOnly: true
type: string
TransferInstrument:
properties:
bankAccount:
@@ -1933,15 +2135,11 @@ components:
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
recurringDetail:
description: Contains information about the legal entity's previously stored
payment details. Required when `type` is **recurringDetail**.
$ref: '#/components/schemas/RecurringDetail'
type:
description: 'The type of transfer instrument.
Possible values: **bankAccount**, **recurringDetail**.'
Possible values: **bankAccount**.'
enum:
- bankAccount
- recurringDetail
@@ -1960,15 +2158,11 @@ components:
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
recurringDetail:
description: Contains information about the legal entity's previously stored
payment details. Required when `type` is **recurringDetail**.
$ref: '#/components/schemas/RecurringDetail'
type:
description: 'The type of transfer instrument.
Possible values: **bankAccount**, **recurringDetail**.'
Possible values: **bankAccount**.'
enum:
- bankAccount
- recurringDetail
@@ -1984,6 +2178,157 @@ components:
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:

404
yaml/LegalEntityService-v2.yaml
View File

@@ -20,7 +20,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n"
x-timestamp: '2022-11-25T14:28:20Z'
x-timestamp: '2022-12-05T17:26:47Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -1234,6 +1234,15 @@ components:
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:
@@ -1259,7 +1268,8 @@ components:
description: 'Specifies which side of the ID card is uploaded.
* When `type` is **driversLicense**, set this to **front** or **back**.
* When `type` is **driversLicense** or **identityCard**, set this to **front**
or **back**.
* When omitted, we infer the page number based on the order of attachments.'
@@ -1312,9 +1322,6 @@ components:
description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html)
standard.
type: string
required:
- countryCode
- currencyCode
BirthData:
properties:
dateOfBirth:
@@ -1323,9 +1330,6 @@ components:
BusinessLine:
properties:
capability:
deprecated: true
x-deprecatedInVersion: '2'
x-deprecatedMessage: Use the `service` instead.
description: The capability for which you are creating the business line.
For example, **receivePayments**.
type: string
@@ -1378,15 +1382,13 @@ components:
description: The reason why the web data is not provided.
$ref: '#/components/schemas/WebDataExemption'
required:
- capability
- industryCode
- legalEntityId
- id
BusinessLineInfo:
properties:
capability:
deprecated: true
x-deprecatedInVersion: '2'
x-deprecatedMessage: Use the `service` instead.
description: The capability for which you are creating the business line.
For example, **receivePayments**.
type: string
@@ -1435,14 +1437,12 @@ components:
description: The reason why the web data is not provided.
$ref: '#/components/schemas/WebDataExemption'
required:
- capability
- industryCode
- legalEntityId
BusinessLineInfoUpdate:
properties:
capability:
deprecated: true
x-deprecatedInVersion: '2'
x-deprecatedMessage: Use the `service` instead.
description: The capability for which you are creating the business line.
For example, **receivePayments**.
type: string
@@ -1499,6 +1499,61 @@ components:
type: array
required:
- businessLines
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:
@@ -1701,6 +1756,11 @@ components:
- residentialAddress
LegalEntity:
properties:
capabilities:
additionalProperties:
$ref: '#/components/schemas/LegalEntityCapability'
description: Overview of capabilities for this legal entity
type: object
documentDetails:
x-addedInVersion: '2'
description: List of documents uploaded for the legal entity.
@@ -1805,8 +1865,97 @@ components:
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.
Possible 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.
Possible 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.
Possible values:
* **pending**: Adyen is running the verification.
* **invalid**: The verification failed. Check if the `errors` array contains
more information.
* **valid**: The verification has been successfully completed.
* **rejected**: Adyen has verified the information, but found reasons
to not allow the capability.
'
readOnly: true
type: string
LegalEntityInfo:
properties:
capabilities:
additionalProperties:
$ref: '#/components/schemas/LegalEntityCapability'
description: Overview of capabilities for this legal entity
type: object
entityAssociations:
description: 'List of legal entities associated with the current legal entity.
@@ -2035,17 +2184,11 @@ components:
type: string
required:
- number
RecurringDetail:
RemediatingAction:
properties:
merchantAccount:
description: The merchant account used when the payment details were stored.
code:
type: string
reference:
description: The `recurringDetailReference` returned in the response when
the payment details were stored.
type: string
shopperReference:
description: The unique identifier used when the payment details were stored.
message:
type: string
ServiceError:
properties:
@@ -2138,6 +2281,58 @@ components:
tickerSymbol:
description: The stock ticker symbol.
type: string
SupportingEntityCapability:
properties:
allowed:
description: 'Indicates whether the supporting entity capability is allowed.
If a supporting entity is allowed but its parent legal entity is not,
it means there are other supporting entities that failed validation.
**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.
Possible values:
* **pending**: Adyen is running the verification.
* **invalid**: The verification failed. Check if the `errors` array contains
more information.
* **valid**: The verification has been successfully completed.
* **rejected**: Adyen has verified the information, but found reasons
to not allow the capability.
'
readOnly: true
type: string
TaxInformation:
properties:
country:
@@ -2220,15 +2415,11 @@ components:
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
recurringDetail:
description: Contains information about the legal entity's previously stored
payment details. Required when `type` is **recurringDetail**.
$ref: '#/components/schemas/RecurringDetail'
type:
description: 'The type of transfer instrument.
Possible values: **bankAccount**, **recurringDetail**.'
Possible values: **bankAccount**.'
enum:
- bankAccount
- recurringDetail
@@ -2247,15 +2438,11 @@ components:
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
recurringDetail:
description: Contains information about the legal entity's previously stored
payment details. Required when `type` is **recurringDetail**.
$ref: '#/components/schemas/RecurringDetail'
type:
description: 'The type of transfer instrument.
Possible values: **bankAccount**, **recurringDetail**.'
Possible values: **bankAccount**.'
enum:
- bankAccount
- recurringDetail
@@ -2271,6 +2458,157 @@ components:
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: