Package com.adyen.model.balanceplatform

Class AccountHolder

  • public class AccountHolder
extends Object
    AccountHolder

    • Constructor Detail

      • AccountHolder

        public AccountHolder()

    • Method Detail

      • balancePlatform

        public AccountHolder balancePlatform​(String balancePlatform)
        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.
        Parameters:
        balancePlatform - 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:
        the current AccountHolder instance, allowing for method chaining

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

      • setBalancePlatform

        public void setBalancePlatform​(String balancePlatform)
        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.
        Parameters:
        balancePlatform - 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.

      • capabilities

        public AccountHolder capabilities​(Map<String,​AccountHolderCapability> capabilities)
        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.
        Parameters:
        capabilities - 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:
        the current AccountHolder instance, allowing for method chaining

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

      • setCapabilities

        public void setCapabilities​(Map<String,​AccountHolderCapability> capabilities)
        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.
        Parameters:
        capabilities - 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.

      • contactDetails

        @Deprecated
public AccountHolder contactDetails​(ContactDetails contactDetails)
        Deprecated.
        contactDetails
        Parameters:
        contactDetails -
        Returns:
        the current AccountHolder instance, allowing for method chaining

      • getContactDetails

        @Deprecated
public ContactDetails getContactDetails()
        Deprecated.
        Get contactDetails
        Returns:
        contactDetails

      • setContactDetails

        @Deprecated
public void setContactDetails​(ContactDetails contactDetails)
        Deprecated.
        contactDetails
        Parameters:
        contactDetails -

      • description

        public AccountHolder description​(String description)
        Your description for the account holder.
        Parameters:
        description - Your description for the account holder.
        Returns:
        the current AccountHolder instance, allowing for method chaining

      • getDescription

        public String getDescription()
        Your description for the account holder.
        Returns:
        description Your description for the account holder.

      • setDescription

        public void setDescription​(String description)
        Your description for the account holder.
        Parameters:
        description - Your description for the account holder.

      • getId

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

      • legalEntityId

        public AccountHolder legalEntityId​(String legalEntityId)
        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.
        Parameters:
        legalEntityId - 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:
        the current AccountHolder instance, allowing for method chaining

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

      • setLegalEntityId

        public void setLegalEntityId​(String legalEntityId)
        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.
        Parameters:
        legalEntityId - 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.

      • metadata

        public AccountHolder metadata​(Map<String,​String> metadata)
        A set of key and value pairs for general use. 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.
        Parameters:
        metadata - A set of key and value pairs for general use. 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:
        the current AccountHolder instance, allowing for method chaining

      • getMetadata

        public Map<String,​String> getMetadata()
        A set of key and value pairs for general use. 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 A set of key and value pairs for general use. 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.

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)
        A set of key and value pairs for general use. 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.
        Parameters:
        metadata - A set of key and value pairs for general use. 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.

      • getMigratedAccountHolderCode

        public String getMigratedAccountHolderCode()
        The unique identifier of the migrated account holder in the classic integration.
        Returns:
        migratedAccountHolderCode The unique identifier of the migrated account holder in the classic integration.

      • primaryBalanceAccount

        public AccountHolder primaryBalanceAccount​(String primaryBalanceAccount)
        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.
        Parameters:
        primaryBalanceAccount - 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:
        the current AccountHolder instance, allowing for method chaining

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

      • setPrimaryBalanceAccount

        public void setPrimaryBalanceAccount​(String primaryBalanceAccount)
        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.
        Parameters:
        primaryBalanceAccount - 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.

      • reference

        public AccountHolder reference​(String reference)
        Your reference for the account holder.
        Parameters:
        reference - Your reference for the account holder.
        Returns:
        the current AccountHolder instance, allowing for method chaining

      • getReference

        public String getReference()
        Your reference for the account holder.
        Returns:
        reference Your reference for the account holder.

      • setReference

        public void setReference​(String reference)
        Your reference for the account holder.
        Parameters:
        reference - Your reference for the account holder.

      • status

        public AccountHolder status​(AccountHolder.StatusEnum status)
        The status of the account holder. Possible values: * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**. * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**. * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
        Parameters:
        status - The status of the account holder. Possible values: * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**. * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**. * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
        Returns:
        the current AccountHolder instance, allowing for method chaining

      • getStatus

        public AccountHolder.StatusEnum getStatus()
        The status of the account holder. Possible values: * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**. * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**. * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
        Returns:
        status The status of the account holder. Possible values: * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**. * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**. * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.

      • setStatus

        public void setStatus​(AccountHolder.StatusEnum status)
        The status of the account holder. Possible values: * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**. * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**. * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
        Parameters:
        status - The status of the account holder. Possible values: * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**. * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**. * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.

      • timeZone

        public AccountHolder timeZone​(String timeZone)
        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).
        Parameters:
        timeZone - 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:
        the current AccountHolder instance, allowing for method chaining

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

      • setTimeZone

        public void setTimeZone​(String timeZone)
        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).
        Parameters:
        timeZone - 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).

      • getVerificationDeadlines

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

      • includeNullValues

        public AccountHolder includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

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

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of AccountHolder to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException