| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountLevelAddonPayments | Collection of APIRecurringPaymentAddonModel |
None. |
|
| Amount |
A dollar amount to be paid on the bill. |
decimal? |
None. |
| CustomerToken |
Contains the unique customer token used to identify the customer the recurring payment is being added/edited for. |
string |
Required |
| DateToStart |
Date to start the recurring payment. |
date-time |
Required |
| DateToStop |
Date to Stop the Recurring Payment |
date-time? |
None. |
| DayToPay |
Indicates what day of the month to pay the bill. |
int? |
None. |
| FeeWaived |
Specifies whether this recurring payment has fee waived. |
boolean |
None. |
| IsPPD |
Check if the recurring payment request confirmation option is PPD. Prearranged Payment and Deposit Entries (PPD): The merchant obtains written authorization to credit or debit to a consumer's bank account |
boolean |
None. |
| NumberToStopOn |
The number of payments to make before stopping recurring payments. |
int? |
None. |
| OtherData |
Other Data |
string |
Required String length: inclusive between 0 and 100 |
| PayAllOutstandingBills |
Option to pay unpaid invoices as part of the first recurring payment. |
boolean |
Required |
| PaymentAccount |
For enrolled or one-time payments, contains the new payment account information to use for the payment. Will be saved as an available payment account for enrolled customers. |
PaymentAccountModel |
None. |
| PaymentAccountToken |
For enrolled payments, contains the payment account token of the existing payment account to use. |
string |
String length: inclusive between 0 and 2048 |
| PaymentName |
The name to be given the recurring payment. |
string |
Required |
| PayThisAmount |
An enum selecting how to choose the amount to be paid on a bill. |
PayThisAmount |
Required |
| PayThisBill |
An enum selecting when in the payment cycle to pay the bill. |
PayThisBill |
Required |
| RecurringPaymentID |
The id of an existing RecurringPayment record. The value must be greater than zero for update and delete. It is not required for add. |
int? |
None. |
| RecurringPaymentStopType |
An enum selecting the Stop Type for the recurring payment. |
RecurringPaymentStopType |
Required |
| ReferenceNumber |
Reference Number |
string |
Required String length: inclusive between 0 and 100 |
| ReminderDaysBeforeDue |
Indicates how many days before a payment date to send a notification regarding the recurring payment. |
int? |
Range: inclusive between 1 and 180 |
| UserLevelAddonPayments | Collection of APIRecurringPaymentAddonModel |
None. |