Class Balance


  • public class Balance
    extends Object
    Balance
    • Constructor Summary

      Constructors 
      Constructor Description
      Balance()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Balance available​(Long available)
      The current balance minus any reserved balance.
      Balance balance​(Long balance)
      The current balance of funds in the balance account.
      Balance currency​(String currency)
      The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
      boolean equals​(Object o)
      Return true if this Balance object is equal to o.
      static Balance fromJson​(String jsonString)
      Create an instance of Balance given an JSON string
      Long getAvailable()
      The current balance minus any reserved balance.
      Long getBalance()
      The current balance of funds in the balance account.
      String getCurrency()
      The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
      Long getPending()
      The amount of funds that Adyen has processed for this account, but will be settled in a future date.
      Long getReserved()
      The amount reserved for payments that have been [authorised](https://docs.adyen.com/issuing/payment-stages/#authorised), but not yet [captured](https://docs.adyen.com/issuing/payment-stages/#captured) by the merchant.
      int hashCode()  
      Balance pending​(Long pending)
      The amount of funds that Adyen has processed for this account, but will be settled in a future date.
      Balance reserved​(Long reserved)
      The amount reserved for payments that have been [authorised](https://docs.adyen.com/issuing/payment-stages/#authorised), but not yet [captured](https://docs.adyen.com/issuing/payment-stages/#captured) by the merchant.
      void setAvailable​(Long available)
      The current balance minus any reserved balance.
      void setBalance​(Long balance)
      The current balance of funds in the balance account.
      void setCurrency​(String currency)
      The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
      void setPending​(Long pending)
      The amount of funds that Adyen has processed for this account, but will be settled in a future date.
      void setReserved​(Long reserved)
      The amount reserved for payments that have been [authorised](https://docs.adyen.com/issuing/payment-stages/#authorised), but not yet [captured](https://docs.adyen.com/issuing/payment-stages/#captured) by the merchant.
      String toJson()
      Convert an instance of Balance to an JSON string
      String toString()  
    • Constructor Detail

      • Balance

        public Balance()
    • Method Detail

      • available

        public Balance available​(Long available)
        The current balance minus any reserved balance.
        Parameters:
        available -
        Returns:
        the current Balance instance, allowing for method chaining
      • getAvailable

        public Long getAvailable()
        The current balance minus any reserved balance.
        Returns:
        available
      • setAvailable

        public void setAvailable​(Long available)
        The current balance minus any reserved balance.
        Parameters:
        available -
      • balance

        public Balance balance​(Long balance)
        The current balance of funds in the balance account. These are the funds from all transactions with a value date in the past that have not yet been paid out.
        Parameters:
        balance -
        Returns:
        the current Balance instance, allowing for method chaining
      • getBalance

        public Long getBalance()
        The current balance of funds in the balance account. These are the funds from all transactions with a value date in the past that have not yet been paid out.
        Returns:
        balance
      • setBalance

        public void setBalance​(Long balance)
        The current balance of funds in the balance account. These are the funds from all transactions with a value date in the past that have not yet been paid out.
        Parameters:
        balance -
      • currency

        public Balance currency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
        Parameters:
        currency -
        Returns:
        the current Balance instance, allowing for method chaining
      • getCurrency

        public String getCurrency()
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
        Returns:
        currency
      • setCurrency

        public void setCurrency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
        Parameters:
        currency -
      • pending

        public Balance pending​(Long pending)
        The amount of funds that Adyen has processed for this account, but will be settled in a future date. For more information, see how to settle funds for users in your [platform](https://docs.adyen.com/platforms/settle-funds) and [marketplace](https://docs.adyen.com/marketplaces/settle-funds).
        Parameters:
        pending -
        Returns:
        the current Balance instance, allowing for method chaining
      • getPending

        public Long getPending()
        The amount of funds that Adyen has processed for this account, but will be settled in a future date. For more information, see how to settle funds for users in your [platform](https://docs.adyen.com/platforms/settle-funds) and [marketplace](https://docs.adyen.com/marketplaces/settle-funds).
        Returns:
        pending
      • setPending

        public void setPending​(Long pending)
        The amount of funds that Adyen has processed for this account, but will be settled in a future date. For more information, see how to settle funds for users in your [platform](https://docs.adyen.com/platforms/settle-funds) and [marketplace](https://docs.adyen.com/marketplaces/settle-funds).
        Parameters:
        pending -
      • reserved

        public Balance reserved​(Long reserved)
        The amount reserved for payments that have been [authorised](https://docs.adyen.com/issuing/payment-stages/#authorised), but not yet [captured](https://docs.adyen.com/issuing/payment-stages/#captured) by the merchant. Applies only to [Adyen-issued cards](https://docs.adyen.com/issuing).
        Parameters:
        reserved -
        Returns:
        the current Balance instance, allowing for method chaining
      • getReserved

        public Long getReserved()
        The amount reserved for payments that have been [authorised](https://docs.adyen.com/issuing/payment-stages/#authorised), but not yet [captured](https://docs.adyen.com/issuing/payment-stages/#captured) by the merchant. Applies only to [Adyen-issued cards](https://docs.adyen.com/issuing).
        Returns:
        reserved
      • setReserved

        public void setReserved​(Long reserved)
        The amount reserved for payments that have been [authorised](https://docs.adyen.com/issuing/payment-stages/#authorised), but not yet [captured](https://docs.adyen.com/issuing/payment-stages/#captured) by the merchant. Applies only to [Adyen-issued cards](https://docs.adyen.com/issuing).
        Parameters:
        reserved -
      • equals

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

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

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

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