Package com.orbipay.paymentsapi.client.wrappers

Class PaymentSchedule

  • public class PaymentSchedule
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      PaymentSchedule()  
      PaymentSchedule​(java.lang.String paymentRecurringType, java.lang.String paymentRecurringCount, java.lang.String paymentAmountType, java.lang.String paymentStartDate, java.lang.String paymentEndDate, java.lang.String paymentLimitAmount, java.lang.String paymentPlanId, java.lang.String paymentDeferDays)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static PaymentSchedule fromJson​(java.lang.String json)  
      java.lang.String getPaymentAmountType()
      The amount type that is used to set the amount for payments created as part of a recurring payment or autopay setup.
      java.lang.String getPaymentDeferDays()
      The number of days from the bill due date that the customer wishes to delay the autopay payment by.
      java.lang.String getPaymentEndDate()
      The date by which the last payment will be drafted as part of a recurring payment setup.
      java.lang.String getPaymentLimitAmount()
      The upper limit for the payment amount in the case of recurring or autopay payments.
      java.lang.String getPaymentPlanId()
      The reference to the payment plan, offered by the biller, that is used to set up the recurring payment.
      java.lang.String getPaymentRecurringCount()
      The maximum number of payments that can be created as part of a recurring payment setup.
      java.lang.String getPaymentRecurringType()
      The frequency of the payments created as part of a payment setup.
      java.lang.String getPaymentStartDate()
      The date on which the first payment will be drafted as part of a recurring payment setup.
      java.lang.String toJson()  
      PaymentSchedule withPaymentLimitAmount​(java.lang.String paymentLimitAmount)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PaymentSchedule

        public PaymentSchedule()

      • PaymentSchedule

        public PaymentSchedule​(java.lang.String paymentRecurringType,
                       java.lang.String paymentRecurringCount,
                       java.lang.String paymentAmountType,
                       java.lang.String paymentStartDate,
                       java.lang.String paymentEndDate,
                       java.lang.String paymentLimitAmount,
                       java.lang.String paymentPlanId,
                       java.lang.String paymentDeferDays)

    • Method Detail

      • getPaymentRecurringType

        public java.lang.String getPaymentRecurringType()
        The frequency of the payments created as part of a payment setup. This is applicable only for recurring payment setup, in which case it is mandatory.
        Returns:
        paymentRecurringType

      • getPaymentRecurringCount

        public java.lang.String getPaymentRecurringCount()
        The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups.
        Returns:
        paymentRecurringCount

      • getPaymentAmountType

        public java.lang.String getPaymentAmountType()
        The amount type that is used to set the amount for payments created as part of a recurring payment or autopay setup. In the case of a recurring payment setup, the payment amount can be specified by the customer. In that case, the payment_amount_type should not be sent as it would default to 'other'. In the case of an autopay setup, the payment amount type is mandatory and it cannot be specified as 'other'. In this case, the payment amount should not be sent.
        Returns:
        paymentAmountType

      • getPaymentStartDate

        public java.lang.String getPaymentStartDate()
        The date on which the first payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This is mandatory for recurring payment setup. This cannot be specified for autopay setups.
        Returns:
        paymentStartDate

      • getPaymentEndDate

        public java.lang.String getPaymentEndDate()
        The date by which the last payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This cannot be specified for autopay setups.
        Returns:
        paymentEndDate

      • getPaymentLimitAmount

        public java.lang.String getPaymentLimitAmount()
        The upper limit for the payment amount in the case of recurring or autopay payments. Any amount above the limit will not be paid automatically as part of recurring payments and autopay.
        Returns:
        paymentLimitAmount

      • getPaymentPlanId

        public java.lang.String getPaymentPlanId()
        The reference to the payment plan, offered by the biller, that is used to set up the recurring payment. The list of payment plans offered is published as part of the biller set-up.
        Returns:
        paymentPlanId

      • getPaymentDeferDays

        public java.lang.String getPaymentDeferDays()
        The number of days from the bill due date that the customer wishes to delay the autopay payment by. By default an autopay payment is drafted on the bill due date.
        Returns:
        paymentDeferDays

      • withPaymentLimitAmount

        public PaymentSchedule withPaymentLimitAmount​(java.lang.String paymentLimitAmount)
        Parameters:
        paymentLimitAmount - : The paymentLimitAmount is of type String.
        Returns:
        PaymentSchedule: The Instance of PaymentSchedule.