Package com.adyen.model.payment

Class Installments

  • public class Installments
extends Object
    Installments

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Installments.PlanEnum
      The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico).

    • Constructor Summary

      Constructors 
      Constructor Description
      Installments()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object o)
      Return true if this Installments object is equal to o.
      Installments extra​(Integer extra)
      Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later.
      static Installments fromJson​(String jsonString)
      Create an instance of Installments given an JSON string
      Integer getExtra()
      Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later.
      Installments.PlanEnum getPlan()
      The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico).
      Integer getValue()
      Defines the number of installments.
      int hashCode()  
      Installments plan​(Installments.PlanEnum plan)
      The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico).
      void setExtra​(Integer extra)
      Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later.
      void setPlan​(Installments.PlanEnum plan)
      The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico).
      void setValue​(Integer value)
      Defines the number of installments.
      String toJson()
      Convert an instance of Installments to an JSON string
      String toString()  
      Installments value​(Integer value)
      Defines the number of installments.

    • Constructor Detail

      • Installments

        public Installments()

    • Method Detail

      • extra

        public Installments extra​(Integer extra)
        Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for [card installments in Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico)
        Parameters:
        extra -
        Returns:
        the current Installments instance, allowing for method chaining

      • getExtra

        public Integer getExtra()
        Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for [card installments in Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico)
        Returns:
        extra

      • setExtra

        public void setExtra​(Integer extra)
        Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for [card installments in Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico)
        Parameters:
        extra -

      • plan

        public Installments plan​(Installments.PlanEnum plan)
        The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico). By default, this is set to **regular**.
        Parameters:
        plan -
        Returns:
        the current Installments instance, allowing for method chaining

      • getPlan

        public Installments.PlanEnum getPlan()
        The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico). By default, this is set to **regular**.
        Returns:
        plan

      • setPlan

        public void setPlan​(Installments.PlanEnum plan)
        The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico). By default, this is set to **regular**.
        Parameters:
        plan -

      • value

        public Installments value​(Integer value)
        Defines the number of installments. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. This value can be zero for Installments processed in Mexico.
        Parameters:
        value -
        Returns:
        the current Installments instance, allowing for method chaining

      • getValue

        public Integer getValue()
        Defines the number of installments. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. This value can be zero for Installments processed in Mexico.
        Returns:
        value

      • setValue

        public void setValue​(Integer value)
        Defines the number of installments. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. This value can be zero for Installments processed in Mexico.
        Parameters:
        value -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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