Package com.adyen.model.legalentitymanagement

Class LegalEntity

  • public class LegalEntity
extends Object
    LegalEntity

    • Constructor Detail

      • LegalEntity

        public LegalEntity()

    • Method Detail

      • capabilities

        public LegalEntity capabilities​(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 -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        List of documents uploaded for the legal entity.
        Parameters:
        documentDetails -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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.
        since Legal Entity Management API v1 Use the `documentDetails` array instead.
        List of documents uploaded for the legal entity.
        Parameters:
        documents -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • getDocuments

        @Deprecated
public List<EntityReference> getDocuments()
        Deprecated.
        since Legal Entity Management API v1 Use the `documentDetails` array instead.
        List of documents uploaded for the legal entity.
        Returns:
        documents

      • setDocuments

        @Deprecated
public void setDocuments​(List<EntityReference> documents)
        Deprecated.
        since Legal Entity Management API v1 Use the `documentDetails` array instead.
        List of documents uploaded for the legal entity.
        Parameters:
        documents -

      • entityAssociations

        public LegalEntity entityAssociations​(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 -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        The unique identifier of the legal entity.
        Parameters:
        id -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        individual
        Parameters:
        individual -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • getIndividual

        public Individual getIndividual()
        individual
        Returns:
        individual

      • setIndividual

        public void setIndividual​(Individual individual)
        individual
        Parameters:
        individual -

      • organization

        public LegalEntity organization​(Organization organization)
        organization
        Parameters:
        organization -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • getOrganization

        public Organization getOrganization()
        organization
        Returns:
        organization

      • setOrganization

        public void setOrganization​(Organization organization)
        organization
        Parameters:
        organization -

      • problems

        public LegalEntity problems​(List<CapabilityProblem> problems)
        List of verification errors related to capabilities for the legal entity.
        Parameters:
        problems -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        Your reference for the legal entity, maximum 150 characters.
        Parameters:
        reference -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        soleProprietorship
        Parameters:
        soleProprietorship -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • getSoleProprietorship

        public SoleProprietorship getSoleProprietorship()
        soleProprietorship
        Returns:
        soleProprietorship

      • setSoleProprietorship

        public void setSoleProprietorship​(SoleProprietorship soleProprietorship)
        soleProprietorship
        Parameters:
        soleProprietorship -

      • transferInstruments

        public LegalEntity transferInstruments​(List<TransferInstrumentReference> transferInstruments)
        List of transfer instruments that the legal entity owns.
        Parameters:
        transferInstruments -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        trust
        Parameters:
        trust -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • getTrust

        public Trust getTrust()
        trust
        Returns:
        trust

      • setTrust

        public void setTrust​(Trust trust)
        trust
        Parameters:
        trust -

      • type

        public LegalEntity type​(LegalEntity.TypeEnum type)
        The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**.
        Parameters:
        type -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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 -

      • unincorporatedPartnership

        public LegalEntity unincorporatedPartnership​(UnincorporatedPartnership unincorporatedPartnership)
        unincorporatedPartnership
        Parameters:
        unincorporatedPartnership -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • getUnincorporatedPartnership

        public UnincorporatedPartnership getUnincorporatedPartnership()
        unincorporatedPartnership
        Returns:
        unincorporatedPartnership

      • setUnincorporatedPartnership

        public void setUnincorporatedPartnership​(UnincorporatedPartnership unincorporatedPartnership)
        unincorporatedPartnership
        Parameters:
        unincorporatedPartnership -

      • verificationDeadlines

        public LegalEntity verificationDeadlines​(List<VerificationDeadline> verificationDeadlines)
        List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
        Parameters:
        verificationDeadlines -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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)
        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/verification-overview/verification-types/#upfront-verification).
        Parameters:
        verificationPlan -
        Returns:
        the current LegalEntity instance, allowing for method chaining

      • 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/verification-overview/verification-types/#upfront-verification).
        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/verification-overview/verification-types/#upfront-verification).
        Parameters:
        verificationPlan -

      • equals

        public boolean equals​(Object o)
        Return true if this LegalEntity object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • 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