Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo Class Reference

More...

Inheritance diagram for Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo:

Public Member Functions
	PaymentScheduleVo (string paymentRecurringType=default(string), string paymentRecurringCount=default(string), string paymentAmountType=default(string), string paymentStartDate=default(string), string paymentEndDate=default(string), string paymentLimitAmount=default(string), string paymentPlanId=default(string), string paymentDeferDays=default(string))
	Initializes a new instance of the PaymentScheduleVo class. More...
override string	ToString ()
	Returns the string presentation of the object More...
virtual string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object input)
	Returns true if objects are equal More...
bool	Equals (PaymentScheduleVo input)
	Returns true if PaymentScheduleVo instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Properties
string	PaymentRecurringCount [get, set]
	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	PaymentStartDate [get, set]
	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 [get, set]
	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 [get, set]
	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 [get, set]
	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 [get, set]
	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...

Detailed Description

This class subject to change without prior notice, Please dont use this class directly.

Constructor & Destructor Documentation

Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.PaymentScheduleVo	(	string	paymentRecurringType = default(string),
		string	paymentRecurringCount = default(string),
		string	paymentAmountType = default(string),
		string	paymentStartDate = default(string),
		string	paymentEndDate = default(string),
		string	paymentLimitAmount = default(string),
		string	paymentPlanId = default(string),
		string	paymentDeferDays = default(string)
	)

Initializes a new instance of the PaymentScheduleVo class.

Parameters

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..
paymentRecurringCount	The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups..
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..
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..
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..
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..
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..
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..

Member Function Documentation

override bool Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.Equals

(

object

input

)

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

bool Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.Equals

(

PaymentScheduleVo

input

)

Returns true if PaymentScheduleVo instances are equal

Parameters

input

Instance of PaymentScheduleVo to be compared

Returns

Boolean

override int Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.GetHashCode

(

)

Gets the hash code

Returns

Hash code

virtual string Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.ToJson ( )

virtual

Returns the JSON string presentation of the object

Returns

string

override string Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.ToString

(

)

Returns the string presentation of the object

Returns

string

Property Documentation

string Orbipay.PaymentsApi.Client.Models.PaymentScheduleVo.PaymentDeferDays

getset

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.Models.PaymentScheduleVo.PaymentEndDate

getset

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.Models.PaymentScheduleVo.PaymentLimitAmount

getset

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.Models.PaymentScheduleVo.PaymentPlanId

getset

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.Models.PaymentScheduleVo.PaymentRecurringCount

getset

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.Models.PaymentScheduleVo.PaymentStartDate

getset

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/Models/PaymentScheduleVo.cs