Class Balance


  • public class Balance
    extends Object
    Balance
    • Constructor Detail

      • Balance

        public Balance()
    • Method Detail

      • currency

        public Balance currency​(String currency)
        The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        Parameters:
        currency - The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
        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).
        Returns:
        currency The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      • setCurrency

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

        public Balance fee​(Long fee)
        The amount of the grant fee.
        Parameters:
        fee - The amount of the grant fee.
        Returns:
        the current Balance instance, allowing for method chaining
      • getFee

        public Long getFee()
        The amount of the grant fee.
        Returns:
        fee The amount of the grant fee.
      • setFee

        public void setFee​(Long fee)
        The amount of the grant fee.
        Parameters:
        fee - The amount of the grant fee.
      • principal

        public Balance principal​(Long principal)
        The grant amount that is paid out to the user for business financing.
        Parameters:
        principal - The grant amount that is paid out to the user for business financing.
        Returns:
        the current Balance instance, allowing for method chaining
      • getPrincipal

        public Long getPrincipal()
        The grant amount that is paid out to the user for business financing.
        Returns:
        principal The grant amount that is paid out to the user for business financing.
      • setPrincipal

        public void setPrincipal​(Long principal)
        The grant amount that is paid out to the user for business financing.
        Parameters:
        principal - The grant amount that is paid out to the user for business financing.
      • total

        public Balance total​(Long total)
        The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
        Parameters:
        total - The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
        Returns:
        the current Balance instance, allowing for method chaining
      • getTotal

        public Long getTotal()
        The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
        Returns:
        total The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
      • setTotal

        public void setTotal​(Long total)
        The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
        Parameters:
        total - The total amount of the grant that the user must repay. It is the sum of the fee amount and the principal amount.
      • includeNullValues

        public Balance 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 Balance 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 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