Package com.adyen.model.balanceplatform

Class AccountHolderInfo

  • public class AccountHolderInfo
extends Object
    AccountHolderInfo

    • Constructor Detail

      • AccountHolderInfo

        public AccountHolderInfo()

      • AccountHolderInfo

        public AccountHolderInfo​(String migratedAccountHolderCode)

    • Method Detail

      • balancePlatform

        public AccountHolderInfo 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 AccountHolderInfo 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 AccountHolderInfo 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 AccountHolderInfo 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 AccountHolderInfo contactDetails​(ContactDetails contactDetails)
        Deprecated.
        contactDetails
        Parameters:
        contactDetails -
        Returns:
        the current AccountHolderInfo 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 AccountHolderInfo description​(String description)
        Your description for the account holder.
        Parameters:
        description - Your description for the account holder.
        Returns:
        the current AccountHolderInfo 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.

      • legalEntityId

        public AccountHolderInfo 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 AccountHolderInfo 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 AccountHolderInfo 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 AccountHolderInfo 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.

      • reference

        public AccountHolderInfo reference​(String reference)
        Your reference for the account holder.
        Parameters:
        reference - Your reference for the account holder.
        Returns:
        the current AccountHolderInfo 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.

      • timeZone

        public AccountHolderInfo 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 AccountHolderInfo 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).

      • includeNullValues

        public AccountHolderInfo 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 AccountHolderInfo 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 AccountHolderInfo fromJson​(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of AccountHolderInfo given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of AccountHolderInfo
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to AccountHolderInfo

      • toJson

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