Package com.adyen.model.legalentitymanagement

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 class	LegalEntity.CustomTypeAdapterFactory
static class	LegalEntity.TypeEnum	The type of legal entity.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_CAPABILITIES
static String	SERIALIZED_NAME_DOCUMENT_DETAILS
static String	SERIALIZED_NAME_DOCUMENTS
static String	SERIALIZED_NAME_ENTITY_ASSOCIATIONS
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_INDIVIDUAL
static String	SERIALIZED_NAME_ORGANIZATION
static String	SERIALIZED_NAME_REFERENCE
static String	SERIALIZED_NAME_SOLE_PROPRIETORSHIP
static String	SERIALIZED_NAME_TRANSFER_INSTRUMENTS
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor	Description
LegalEntity()
LegalEntity(Map<String,LegalEntityCapability> capabilities, String id)

Method Summary

Modifier and Type	Method	Description
LegalEntity	addDocumentDetailsItem(DocumentReference documentDetailsItem)
LegalEntity	addDocumentsItem(EntityReference documentsItem)
LegalEntity	addEntityAssociationsItem(LegalEntityAssociation entityAssociationsItem)
LegalEntity	addTransferInstrumentsItem(TransferInstrumentReference transferInstrumentsItem)
LegalEntity	documentDetails(List<DocumentReference> documentDetails)
LegalEntity	documents(List<EntityReference> documents)
LegalEntity	entityAssociations(List<LegalEntityAssociation> entityAssociations)
boolean	equals(Object o)
static LegalEntity	fromJson(String jsonString)	Create an instance of LegalEntity given an JSON string
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.
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.
String	getId()	The unique identifier of the legal entity.
Individual	getIndividual()	Get individual
Organization	getOrganization()	Get organization
String	getReference()	Your reference for the legal entity, maximum 150 characters.
SoleProprietorship	getSoleProprietorship()	Get soleProprietorship
List<TransferInstrumentReference>	getTransferInstruments()	List of transfer instruments owned by the legal entity.
LegalEntity.TypeEnum	getType()	The type of legal entity.
int	hashCode()
LegalEntity	individual(Individual individual)
LegalEntity	organization(Organization organization)
LegalEntity	reference(String reference)
void	setDocumentDetails(List<DocumentReference> documentDetails)
void	setDocuments(List<EntityReference> documents)
void	setEntityAssociations(List<LegalEntityAssociation> entityAssociations)
void	setIndividual(Individual individual)
void	setOrganization(Organization organization)
void	setReference(String reference)
void	setSoleProprietorship(SoleProprietorship soleProprietorship)
void	setTransferInstruments(List<TransferInstrumentReference> transferInstruments)
void	setType(LegalEntity.TypeEnum type)
LegalEntity	soleProprietorship(SoleProprietorship soleProprietorship)
String	toJson()	Convert an instance of LegalEntity to an JSON string
String	toString()
LegalEntity	transferInstruments(List<TransferInstrumentReference> transferInstruments)
LegalEntity	type(LegalEntity.TypeEnum type)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_CAPABILITIES

public static final String SERIALIZED_NAME_CAPABILITIES

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_DETAILS

public static final String SERIALIZED_NAME_DOCUMENT_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENTS

public static final String SERIALIZED_NAME_DOCUMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_ENTITY_ASSOCIATIONS

public static final String SERIALIZED_NAME_ENTITY_ASSOCIATIONS

See Also:

Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_INDIVIDUAL

public static final String SERIALIZED_NAME_INDIVIDUAL

See Also:

Constant Field Values

SERIALIZED_NAME_ORGANIZATION

public static final String SERIALIZED_NAME_ORGANIZATION

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE

public static final String SERIALIZED_NAME_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_SOLE_PROPRIETORSHIP

public static final String SERIALIZED_NAME_SOLE_PROPRIETORSHIP

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER_INSTRUMENTS

public static final String SERIALIZED_NAME_TRANSFER_INSTRUMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

LegalEntity

public LegalEntity()

LegalEntity

public LegalEntity(Map<String,LegalEntityCapability> capabilities,
                   String id)

Method Detail

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

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)

documents

public LegalEntity documents(List<EntityReference> documents)

addDocumentsItem

public LegalEntity addDocumentsItem(EntityReference documentsItem)

getDocuments

@Deprecated
public List<EntityReference> getDocuments()

Deprecated.

List of documents uploaded for the legal entity.

Returns:

documents

setDocuments

public void setDocuments(List<EntityReference> 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)

getId

public String getId()

The unique identifier of the legal entity.

Returns:

id

individual

public LegalEntity individual(Individual individual)

getIndividual

public Individual getIndividual()

Get individual

Returns:

individual

setIndividual

public void setIndividual(Individual individual)

organization

public LegalEntity organization(Organization organization)

getOrganization

public Organization getOrganization()

Get organization

Returns:

organization

setOrganization

public void setOrganization(Organization organization)

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)

soleProprietorship

public LegalEntity soleProprietorship(SoleProprietorship soleProprietorship)

getSoleProprietorship

public SoleProprietorship getSoleProprietorship()

Get soleProprietorship

Returns:

soleProprietorship

setSoleProprietorship

public void setSoleProprietorship(SoleProprietorship soleProprietorship)

transferInstruments

public LegalEntity transferInstruments(List<TransferInstrumentReference> transferInstruments)

addTransferInstrumentsItem

public LegalEntity addTransferInstrumentsItem(TransferInstrumentReference transferInstrumentsItem)

getTransferInstruments

public List<TransferInstrumentReference> getTransferInstruments()

List of transfer instruments owned by the legal entity.

Returns:

transferInstruments

setTransferInstruments

public void setTransferInstruments(List<TransferInstrumentReference> transferInstruments)

type

public LegalEntity type(LegalEntity.TypeEnum type)

getType

public LegalEntity.TypeEnum getType()

The type of legal entity. Possible values: **individual**, **organization**, or **soleProprietorship**.

Returns:

type

setType

public void setType(LegalEntity.TypeEnum type)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to LegalEntity

fromJson

public static LegalEntity fromJson(String jsonString)
                            throws IOException

Create an instance of LegalEntity given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LegalEntity

Throws:

IOException - if the JSON string is invalid with respect to LegalEntity

toJson

public String toJson()

Convert an instance of LegalEntity to an JSON string

Returns:

JSON string