Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule Class Reference

Public Member Functions
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
	PaymentSchedule (string paymentRecurringType=null, string paymentRecurringCount=null, string paymentAmountType=null, string paymentStartDate=null, string paymentEndDate=null, string paymentLimitAmount=null, string paymentPlanId=null, string paymentDeferDays=null)
PaymentSchedule	WithPaymentLimitAmount (string paymentLimitAmount)
IEnumerator< PaymentSchedule >	GetEnumerator ()

Public Attributes
string	PaymentRecurringType
	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. More...
string	PaymentRecurringCount
	The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups. More...
string	PaymentAmountType
	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. More...
string	PaymentStartDate
	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. More...
string	PaymentEndDate
	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. More...
string	PaymentLimitAmount
	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. More...
string	PaymentPlanId
	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. More...
string	PaymentDeferDays
	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. More...

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentSchedule	(	string	paymentRecurringType = null,
		string	paymentRecurringCount = null,
		string	paymentAmountType = null,
		string	paymentStartDate = null,
		string	paymentEndDate = null,
		string	paymentLimitAmount = null,
		string	paymentPlanId = null,
		string	paymentDeferDays = null
	)

PaymentSchedule Constructor.

Parameters

PaymentRecurringType	The PaymentRecurringType is of type string
PaymentRecurringCount	The PaymentRecurringCount is of type string
PaymentAmountType	The PaymentAmountType is of type string
PaymentStartDate	The PaymentStartDate is of type string
PaymentEndDate	The PaymentEndDate is of type string
PaymentLimitAmount	The PaymentLimitAmount is of type string
PaymentPlanId	The PaymentPlanId is of type string
PaymentDeferDays	The PaymentDeferDays is of type string

Member Function Documentation

IEnumerator<PaymentSchedule> Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.GetEnumerator

(

)

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.GetPaymentRecurringCount

(

)

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

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.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.

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.

PaymentSchedule Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.WithPaymentLimitAmount

(

string

paymentLimitAmount

)

WithPaymentLimitAmount Method.

Parameters

PaymentLimitAmount

The PaymentLimitAmount is of type string

Returns

PaymentSchedule

Member Data Documentation

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentAmountType

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentDeferDays

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentEndDate

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentLimitAmount

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentPlanId

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentRecurringCount

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

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

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentRecurringType

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.

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.

string Orbipay.PaymentsApi.Client.Wrappers.PaymentSchedule.PaymentStartDate

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.

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.

---

The documentation for this class was generated from the following file:

• src/Orbipay.PaymentsApi.Client/Wrappers/PaymentSchedule.cs