Package com.adyen.model.checkout

Class Surcharge

  • public class Surcharge
extends Object
    Surcharge

    • Constructor Summary

      Constructors 
      Constructor Description
      Surcharge()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object o)
      Return true if this Surcharge object is equal to o.
      static Surcharge fromJson​(String jsonString)
      Create an instance of Surcharge given an JSON string
      Map<String,​Object> getExplicitNulls()
      Returns a map of properties to be merged into the JSON payload as explicit null values.
      Long getValue()
      The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
      int hashCode()  
      Surcharge includeNullValues​(boolean includeNullValues)
      Configures whether null values are explicitly serialized in the JSON payload.
      boolean isIncludeNullValues()
      Returns whether null values are explicitly serialized in the JSON payload.
      void setIncludeNullValues​(boolean includeNullValues)
      Sets whether null values should be explicitly serialized in the JSON payload.
      void setValue​(Long value)
      The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
      String toJson()
      Convert an instance of Surcharge to an JSON string
      String toString()  
      Surcharge value​(Long value)
      The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

    • Constructor Detail

      • Surcharge

        public Surcharge()

    • Method Detail

      • value

        public Surcharge value​(Long value)
        The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.
        Parameters:
        value - The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.
        Returns:
        the current Surcharge instance, allowing for method chaining

      • getValue

        public Long getValue()
        The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.
        Returns:
        value The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.

      • setValue

        public void setValue​(Long value)
        The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.
        Parameters:
        value - The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.

      • includeNullValues

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

      • toJson

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