Package com.adyen.model.balanceplatform

Class AccountHolder

  • public class AccountHolder
extends Object
    AccountHolder

    • Method Detail

      • getBalancePlatform

        public String getBalancePlatform()
        The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
        Returns:
        balancePlatform

      • setBalancePlatform

        public void setBalancePlatform​(String balancePlatform)

      • getCapabilities

        public Map<String,​AccountHolderCapability> getCapabilities()
        Contains key-value pairs that specify the actions that an account holder 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

      • getContactDetails

        public ContactDetails getContactDetails()
        Get contactDetails
        Returns:
        contactDetails

      • setContactDetails

        public void setContactDetails​(ContactDetails contactDetails)

      • getDescription

        public String getDescription()
        Your description for the account holder, maximum 300 characters.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • getId

        public String getId()
        The unique identifier of the account holder.
        Returns:
        id

      • getLegalEntityId

        public String getLegalEntityId()
        The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
        Returns:
        legalEntityId

      • setLegalEntityId

        public void setLegalEntityId​(String legalEntityId)

      • getMetadata

        public Map<String,​String> getMetadata()
        A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)

      • primaryBalanceAccount

        public AccountHolder primaryBalanceAccount​(String primaryBalanceAccount)

      • getPrimaryBalanceAccount

        public String getPrimaryBalanceAccount()
        The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
        Returns:
        primaryBalanceAccount

      • setPrimaryBalanceAccount

        public void setPrimaryBalanceAccount​(String primaryBalanceAccount)

      • getReference

        public String getReference()
        Your reference for the account holder, maximum 150 characters.
        Returns:
        reference

      • setReference

        public void setReference​(String reference)

      • getStatus

        public AccountHolder.StatusEnum getStatus()
        The status of the account holder. Possible values: * **active**: The account holder is active. This is the default status when creating an account holder. * **inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. * **closed**: The account holder is permanently deactivated by you. This action cannot be undone.
        Returns:
        status

      • getTimeZone

        public String getTimeZone()
        The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
        Returns:
        timeZone

      • setTimeZone

        public void setTimeZone​(String timeZone)

      • getVerificationDeadlines

        public List<VerificationDeadline> getVerificationDeadlines()
        List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
        Returns:
        verificationDeadlines

      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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 AccountHolder

      • fromJson

        public static AccountHolder fromJson​(String jsonString)
                              throws IOException
        Create an instance of AccountHolder given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of AccountHolder
        Throws:
        IOException - if the JSON string is invalid with respect to AccountHolder

      • toJson

        public String toJson()
        Convert an instance of AccountHolder to an JSON string
        Returns:
        JSON string