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.
-
inner payment_defer_days :String
-
The number of days from the bill due date that the customer wishes to delay the autopay payment by.
-
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.
-
inner payment_limit_amount :String
-
The upper limit for the payment amount in the case of recurring or autopay payments.
-
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.
-
inner payment_recurring_type :String
-
The frequency of the payments created as part of a payment setup.
-
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.
Methods
-
static constructFromObject(data, obj) → {module:wrappers/PaymentSchedule}
-
Constructs a
PaymentSchedulefrom a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdatatoobjif supplied or a new instance if not.Parameters:
Name Type Description dataObject The plain JavaScript object bearing properties of interest.
objmodule:wrappers/PaymentSchedule Optional instance to populate.
-
withPaymentLimitAmount(payment_limit_amount) → {module:wrappers/PaymentSchedule}
-
Parameters:
Name Type Description payment_limit_amountString The payment_limit_amount of PaymentSchedule.