Class BalanceAccount


  • public class BalanceAccount
    extends Object
    BalanceAccount
    • Constructor Detail

      • BalanceAccount

        public BalanceAccount()
    • Method Detail

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

        public List<Balance> getBalances()
        List of balances with the amount and currency.
        Returns:
        balances
      • setBalances

        public void setBalances​(List<Balance> balances)
      • 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**.
        Returns:
        defaultCurrencyCode
      • setDefaultCurrencyCode

        public void setDefaultCurrencyCode​(String defaultCurrencyCode)
      • 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)
      • getId

        public String getId()
        The unique identifier of the balance account.
        Returns:
        id
      • setId

        public void setId​(String id)
      • getPaymentInstruments

        public List<PaymentInstrumentReference> getPaymentInstruments()
        List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments) associated with the balance account.
        Returns:
        paymentInstruments
      • getReference

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

        public void setReference​(String reference)
      • getStatus

        public BalanceAccount.StatusEnum getStatus()
        The status of the balance account, set to **Active** by default.
        Returns:
        status
      • getSweepConfigurations

        public Map<String,​SweepConfiguration> getSweepConfigurations()
        Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds). The key must be a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.
        Returns:
        sweepConfigurations
      • 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)
      • 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 BalanceAccount
      • fromJson

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

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