wrappers/PaymentSchedule

The PaymentSchedule wrapper module.

Members

inner payment_amount_type :String

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.

inner payment_defer_days :String

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.

inner payment_end_date :String

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.

inner payment_limit_amount :String

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.

inner payment_plan_id :String

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.

inner payment_recurring_count :String

The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups.

inner payment_recurring_type :String

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.

inner payment_start_date :String

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.

Methods

static constructFromObject(data, obj) → {module:wrappers/PaymentSchedule}

Constructs a PaymentSchedule from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:wrappers/PaymentSchedule

Optional instance to populate.

Returns:
module:wrappers/PaymentSchedule -

The populated PaymentSchedule instance.

withPaymentLimitAmount(payment_limit_amount) → {module:wrappers/PaymentSchedule}

Parameters:
Name Type Description
payment_limit_amount String

The payment_limit_amount of PaymentSchedule.

Returns:
module:wrappers/PaymentSchedule -

The instance of PaymentSchedule.