Class BalanceAccountInfo


  • public class BalanceAccountInfo
    extends Object
    BalanceAccountInfo
    • Constructor Detail

      • BalanceAccountInfo

        public BalanceAccountInfo()
    • Method Detail

      • accountHolderId

        public BalanceAccountInfo accountHolderId​(String accountHolderId)
        The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
        Parameters:
        accountHolderId -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getAccountHolderId

        public String getAccountHolderId()
        The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
        Returns:
        accountHolderId
      • setAccountHolderId

        public void setAccountHolderId​(String accountHolderId)
        The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
        Parameters:
        accountHolderId -
      • defaultCurrencyCode

        public BalanceAccountInfo defaultCurrencyCode​(String defaultCurrencyCode)
        The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Parameters:
        defaultCurrencyCode -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getDefaultCurrencyCode

        public String getDefaultCurrencyCode()
        The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Returns:
        defaultCurrencyCode
      • setDefaultCurrencyCode

        public void setDefaultCurrencyCode​(String defaultCurrencyCode)
        The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
        Parameters:
        defaultCurrencyCode -
      • description

        public BalanceAccountInfo description​(String description)
        A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
        Parameters:
        description -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getDescription

        public String getDescription()
        A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
        Returns:
        description
      • setDescription

        public void setDescription​(String description)
        A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
        Parameters:
        description -
      • metadata

        public BalanceAccountInfo 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 -
        Returns:
        the current BalanceAccountInfo 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
      • 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 -
      • migratedAccountCode

        public BalanceAccountInfo migratedAccountCode​(String migratedAccountCode)
        The unique identifier of the account of the migrated account holder in the classic integration.
        Parameters:
        migratedAccountCode -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getMigratedAccountCode

        public String getMigratedAccountCode()
        The unique identifier of the account of the migrated account holder in the classic integration.
        Returns:
        migratedAccountCode
      • setMigratedAccountCode

        public void setMigratedAccountCode​(String migratedAccountCode)
        The unique identifier of the account of the migrated account holder in the classic integration.
        Parameters:
        migratedAccountCode -
      • platformPaymentConfiguration

        public BalanceAccountInfo platformPaymentConfiguration​(PlatformPaymentConfiguration platformPaymentConfiguration)
        platformPaymentConfiguration
        Parameters:
        platformPaymentConfiguration -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getPlatformPaymentConfiguration

        public PlatformPaymentConfiguration getPlatformPaymentConfiguration()
        platformPaymentConfiguration
        Returns:
        platformPaymentConfiguration
      • setPlatformPaymentConfiguration

        public void setPlatformPaymentConfiguration​(PlatformPaymentConfiguration platformPaymentConfiguration)
        platformPaymentConfiguration
        Parameters:
        platformPaymentConfiguration -
      • reference

        public BalanceAccountInfo reference​(String reference)
        Your reference for the balance account, maximum 150 characters.
        Parameters:
        reference -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getReference

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

        public void setReference​(String reference)
        Your reference for the balance account, maximum 150 characters.
        Parameters:
        reference -
      • timeZone

        public BalanceAccountInfo timeZone​(String timeZone)
        The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder 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 -
        Returns:
        the current BalanceAccountInfo instance, allowing for method chaining
      • getTimeZone

        public String getTimeZone()
        The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder 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)
        The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder 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 -
      • equals

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

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

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

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