Class LegalEntity
- java.lang.Object
-
- com.adyen.model.legalentitymanagement.LegalEntity
-
public class LegalEntity extends Object
LegalEntity
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLegalEntity.TypeEnumThe type of legal entity.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CAPABILITIESstatic StringJSON_PROPERTY_DOCUMENT_DETAILSstatic StringJSON_PROPERTY_DOCUMENTSstatic StringJSON_PROPERTY_ENTITY_ASSOCIATIONSstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_INDIVIDUALstatic StringJSON_PROPERTY_ORGANIZATIONstatic StringJSON_PROPERTY_PROBLEMSstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SOLE_PROPRIETORSHIPstatic StringJSON_PROPERTY_TRANSFER_INSTRUMENTSstatic StringJSON_PROPERTY_TRUSTstatic StringJSON_PROPERTY_TYPEstatic StringJSON_PROPERTY_VERIFICATION_DEADLINESstatic StringJSON_PROPERTY_VERIFICATION_PLAN
-
Constructor Summary
Constructors Constructor Description LegalEntity()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LegalEntityaddDocumentDetailsItem(DocumentReference documentDetailsItem)LegalEntityaddDocumentsItem(EntityReference documentsItem)LegalEntityaddEntityAssociationsItem(LegalEntityAssociation entityAssociationsItem)LegalEntityaddProblemsItem(CapabilityProblem problemsItem)LegalEntityaddTransferInstrumentsItem(TransferInstrumentReference transferInstrumentsItem)LegalEntityaddVerificationDeadlinesItem(VerificationDeadline verificationDeadlinesItem)LegalEntitycapabilities(Map<String,LegalEntityCapability> capabilities)LegalEntitydocumentDetails(List<DocumentReference> documentDetails)LegalEntitydocuments(List<EntityReference> documents)Deprecated.LegalEntityentityAssociations(List<LegalEntityAssociation> entityAssociations)booleanequals(Object o)Return true if this LegalEntity object is equal to o.static LegalEntityfromJson(String jsonString)Create an instance of LegalEntity given an JSON stringMap<String,LegalEntityCapability>getCapabilities()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.List<DocumentReference>getDocumentDetails()List of documents uploaded for the legal entity.List<EntityReference>getDocuments()Deprecated.List<LegalEntityAssociation>getEntityAssociations()List of legal entities associated with the current legal entity.StringgetId()The unique identifier of the legal entity.IndividualgetIndividual()Get individualOrganizationgetOrganization()Get organizationList<CapabilityProblem>getProblems()List of verification errors related to capabilities for the legal entity.StringgetReference()Your reference for the legal entity, maximum 150 characters.SoleProprietorshipgetSoleProprietorship()Get soleProprietorshipList<TransferInstrumentReference>getTransferInstruments()List of transfer instruments that the legal entity owns.TrustgetTrust()Get trustLegalEntity.TypeEnumgetType()The type of legal entity.List<VerificationDeadline>getVerificationDeadlines()List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.StringgetVerificationPlan()A key-value pair that specifies the verification process for a legal entity.inthashCode()LegalEntityid(String id)LegalEntityindividual(Individual individual)LegalEntityorganization(Organization organization)LegalEntityproblems(List<CapabilityProblem> problems)LegalEntityputCapabilitiesItem(String key, LegalEntityCapability capabilitiesItem)LegalEntityreference(String reference)voidsetCapabilities(Map<String,LegalEntityCapability> capabilities)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.voidsetDocumentDetails(List<DocumentReference> documentDetails)List of documents uploaded for the legal entity.voidsetDocuments(List<EntityReference> documents)Deprecated.voidsetEntityAssociations(List<LegalEntityAssociation> entityAssociations)List of legal entities associated with the current legal entity.voidsetId(String id)The unique identifier of the legal entity.voidsetIndividual(Individual individual)individualvoidsetOrganization(Organization organization)organizationvoidsetProblems(List<CapabilityProblem> problems)List of verification errors related to capabilities for the legal entity.voidsetReference(String reference)Your reference for the legal entity, maximum 150 characters.voidsetSoleProprietorship(SoleProprietorship soleProprietorship)soleProprietorshipvoidsetTransferInstruments(List<TransferInstrumentReference> transferInstruments)List of transfer instruments that the legal entity owns.voidsetTrust(Trust trust)trustvoidsetType(LegalEntity.TypeEnum type)The type of legal entity.voidsetVerificationDeadlines(List<VerificationDeadline> verificationDeadlines)List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.voidsetVerificationPlan(String verificationPlan)A key-value pair that specifies the verification process for a legal entity.LegalEntitysoleProprietorship(SoleProprietorship soleProprietorship)StringtoJson()Convert an instance of LegalEntity to an JSON stringStringtoString()LegalEntitytransferInstruments(List<TransferInstrumentReference> transferInstruments)LegalEntitytrust(Trust trust)LegalEntitytype(LegalEntity.TypeEnum type)LegalEntityverificationDeadlines(List<VerificationDeadline> verificationDeadlines)LegalEntityverificationPlan(String verificationPlan)
-
-
-
Field Detail
-
JSON_PROPERTY_CAPABILITIES
public static final String JSON_PROPERTY_CAPABILITIES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DOCUMENT_DETAILS
public static final String JSON_PROPERTY_DOCUMENT_DETAILS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DOCUMENTS
public static final String JSON_PROPERTY_DOCUMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENTITY_ASSOCIATIONS
public static final String JSON_PROPERTY_ENTITY_ASSOCIATIONS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INDIVIDUAL
public static final String JSON_PROPERTY_INDIVIDUAL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORGANIZATION
public static final String JSON_PROPERTY_ORGANIZATION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PROBLEMS
public static final String JSON_PROPERTY_PROBLEMS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SOLE_PROPRIETORSHIP
public static final String JSON_PROPERTY_SOLE_PROPRIETORSHIP
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANSFER_INSTRUMENTS
public static final String JSON_PROPERTY_TRANSFER_INSTRUMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRUST
public static final String JSON_PROPERTY_TRUST
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VERIFICATION_DEADLINES
public static final String JSON_PROPERTY_VERIFICATION_DEADLINES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VERIFICATION_PLAN
public static final String JSON_PROPERTY_VERIFICATION_PLAN
- See Also:
- Constant Field Values
-
-
Method Detail
-
capabilities
public LegalEntity capabilities(Map<String,LegalEntityCapability> capabilities)
-
putCapabilitiesItem
public LegalEntity putCapabilitiesItem(String key, LegalEntityCapability capabilitiesItem)
-
getCapabilities
public Map<String,LegalEntityCapability> getCapabilities()
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.- Returns:
- capabilities
-
setCapabilities
public void setCapabilities(Map<String,LegalEntityCapability> capabilities)
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.- Parameters:
capabilities-
-
documentDetails
public LegalEntity documentDetails(List<DocumentReference> documentDetails)
-
addDocumentDetailsItem
public LegalEntity addDocumentDetailsItem(DocumentReference documentDetailsItem)
-
getDocumentDetails
public List<DocumentReference> getDocumentDetails()
List of documents uploaded for the legal entity.- Returns:
- documentDetails
-
setDocumentDetails
public void setDocumentDetails(List<DocumentReference> documentDetails)
List of documents uploaded for the legal entity.- Parameters:
documentDetails-
-
documents
@Deprecated public LegalEntity documents(List<EntityReference> documents)
Deprecated.
-
addDocumentsItem
public LegalEntity addDocumentsItem(EntityReference documentsItem)
-
getDocuments
@Deprecated public List<EntityReference> getDocuments()
Deprecated.List of documents uploaded for the legal entity.- Returns:
- documents
-
setDocuments
@Deprecated public void setDocuments(List<EntityReference> documents)
Deprecated.List of documents uploaded for the legal entity.- Parameters:
documents-
-
entityAssociations
public LegalEntity entityAssociations(List<LegalEntityAssociation> entityAssociations)
-
addEntityAssociationsItem
public LegalEntity addEntityAssociationsItem(LegalEntityAssociation entityAssociationsItem)
-
getEntityAssociations
public List<LegalEntityAssociation> getEntityAssociations()
List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.- Returns:
- entityAssociations
-
setEntityAssociations
public void setEntityAssociations(List<LegalEntityAssociation> entityAssociations)
List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.- Parameters:
entityAssociations-
-
id
public LegalEntity id(String id)
-
getId
public String getId()
The unique identifier of the legal entity.- Returns:
- id
-
setId
public void setId(String id)
The unique identifier of the legal entity.- Parameters:
id-
-
individual
public LegalEntity individual(Individual individual)
-
getIndividual
public Individual getIndividual()
Get individual- Returns:
- individual
-
setIndividual
public void setIndividual(Individual individual)
individual- Parameters:
individual-
-
organization
public LegalEntity organization(Organization organization)
-
getOrganization
public Organization getOrganization()
Get organization- Returns:
- organization
-
setOrganization
public void setOrganization(Organization organization)
organization- Parameters:
organization-
-
problems
public LegalEntity problems(List<CapabilityProblem> problems)
-
addProblemsItem
public LegalEntity addProblemsItem(CapabilityProblem problemsItem)
-
getProblems
public List<CapabilityProblem> getProblems()
List of verification errors related to capabilities for the legal entity.- Returns:
- problems
-
setProblems
public void setProblems(List<CapabilityProblem> problems)
List of verification errors related to capabilities for the legal entity.- Parameters:
problems-
-
reference
public LegalEntity reference(String reference)
-
getReference
public String getReference()
Your reference for the legal entity, maximum 150 characters.- Returns:
- reference
-
setReference
public void setReference(String reference)
Your reference for the legal entity, maximum 150 characters.- Parameters:
reference-
-
soleProprietorship
public LegalEntity soleProprietorship(SoleProprietorship soleProprietorship)
-
getSoleProprietorship
public SoleProprietorship getSoleProprietorship()
Get soleProprietorship- Returns:
- soleProprietorship
-
setSoleProprietorship
public void setSoleProprietorship(SoleProprietorship soleProprietorship)
soleProprietorship- Parameters:
soleProprietorship-
-
transferInstruments
public LegalEntity transferInstruments(List<TransferInstrumentReference> transferInstruments)
-
addTransferInstrumentsItem
public LegalEntity addTransferInstrumentsItem(TransferInstrumentReference transferInstrumentsItem)
-
getTransferInstruments
public List<TransferInstrumentReference> getTransferInstruments()
List of transfer instruments that the legal entity owns.- Returns:
- transferInstruments
-
setTransferInstruments
public void setTransferInstruments(List<TransferInstrumentReference> transferInstruments)
List of transfer instruments that the legal entity owns.- Parameters:
transferInstruments-
-
trust
public LegalEntity trust(Trust trust)
-
getTrust
public Trust getTrust()
Get trust- Returns:
- trust
-
setTrust
public void setTrust(Trust trust)
trust- Parameters:
trust-
-
type
public LegalEntity type(LegalEntity.TypeEnum type)
-
getType
public LegalEntity.TypeEnum getType()
The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**.- Returns:
- type
-
setType
public void setType(LegalEntity.TypeEnum type)
The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**.- Parameters:
type-
-
verificationDeadlines
public LegalEntity verificationDeadlines(List<VerificationDeadline> verificationDeadlines)
-
addVerificationDeadlinesItem
public LegalEntity addVerificationDeadlinesItem(VerificationDeadline verificationDeadlinesItem)
-
getVerificationDeadlines
public List<VerificationDeadline> getVerificationDeadlines()
List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.- Returns:
- verificationDeadlines
-
setVerificationDeadlines
public void setVerificationDeadlines(List<VerificationDeadline> verificationDeadlines)
List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.- Parameters:
verificationDeadlines-
-
verificationPlan
public LegalEntity verificationPlan(String verificationPlan)
-
getVerificationPlan
public String getVerificationPlan()
A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).- Returns:
- verificationPlan
-
setVerificationPlan
public void setVerificationPlan(String verificationPlan)
A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).- Parameters:
verificationPlan-
-
equals
public boolean equals(Object o)
Return true if this LegalEntity object is equal to o.
-
fromJson
public static LegalEntity fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of LegalEntity given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of LegalEntity
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to LegalEntity
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of LegalEntity to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-