API – AutoPay Collections
Updated 7 months ago
- Introduction
- Amount Type (autopay.amountType)
- Method Type (autopay.methodType)
- Recurring Frequency (autopay.recurringFrequency)
- AutoPay Status (autopay.status)
- AutoPay Type (autopay.type)
- Payment Method Account Type (bankacct.type)
- Payment Method Auth Type (payment.echeckauth)
- Process Date Condition
- Recurring Date Option (autopay.recurringDate)
- SchedulingType (autopay.schedulingType)
- Payoff Adjustment (payoffAdjustment)
Introduction
This article catalogues the different values used in API requests relating to AutoPays. For the URL, full body, and some background info on the topic, check out our article on Creating AutoPays in the API.
Amount Type (autopay.amountType)
Value | Description |
autopay.amountType.feesDue | The AutoPay amount will equal the amount of fees currently due |
autopay.amountType.nextDue | The AutoPay amount will be the next due amount |
autopay.amountType.pastDue | The AutoPay amount will be the amount past due on the account |
autopay.amountType.piPastDue | The AutoPay amount will equal the amount of principal and interest past due on the account |
autopay.amountType.static | The AutoPay amount will be the amount specified in the amount field |
autopay.amountType.nextPeriod | The AutoPay amount will be the amount specified next period |
Method Type (autopay.methodType)
Value | Description |
autopay.methodType.debit | Bank Card |
autopay.methodType.echeck | Electronic Check |
autopay.methodType.eft | Electronic Funds Transfer (EFT, used for Canadian borrowers) |
Recurring Frequency (autopay.recurringFrequency)
The Payment Frequency for the AutoPay.
Value | Description |
autopay.recurringFrequency.annually | The AutoPay recurs annually. |
autopay.recurringFrequency.biWeekly | The AutoPay recurs bi-weekly. |
autopay.recurringFrequency.custom | The AutoPay recurs at a custom interval. |
autopay.recurringFrequency.monthly | The AutoPay recurs monthly. |
autopay.recurringFrequency.quarterly | The AutoPay recurs quarterly. |
autopay.recurringFrequency.semiannually | The AutoPay recurs semi-annually |
autopay.recurringFrequency.semimonthly | The AutoPay recurs semi-monthly. |
autopay.recurringFrequency.semiMonthlyAlt | An alternate semi-monthly schedule (see Payment Frequencies). |
autopay.recurringFrequency.single | The AutoPay occurs only once. |
autopay.recurringFrequency.weekly | The AutoPay recurs weekly. |
AutoPay Status (autopay.status)
Value | Description |
autopay.status.cancelled | The AutoPay has been cancelled |
autopay.status.completed | The AutoPay completed successfully |
autopay.status.failed | The AutoPay failed |
autopay.status.pending | The AutoPay is pending for processing. |
AutoPay Type (autopay.type)
Value | Description |
autopay.type.multiple | The AutoPay occurs at whatever dates have payments scheduled. |
autopay.type.recurring | The AutoPay recurs at a regular interval. |
autopay.type.recurringMatch | The AutoPay processes when a payment comes due on the account. |
autopay.type.single | The AutoPay occurs once. |
Payment Method Account Type (bankacct.type)
Value | Description |
bankacct.type.checking | A checking account. |
bankacct.type.savings | A savings account. |
Payment Method Auth Type (payment.echeckauth)
Value | Description |
payment.echeckauth.WEB | Payment authorized via the web. |
payment.echeckauth.PPD | Payment authorized via personal signature. |
payment.echeckauth.CCD | Payment authorized via company signature |
payment.echeckauth.TEL | Payment authorized via telephone. |
Process Date Condition
Value | Description |
calendarDays | Processes payments on calendar days. |
bankingDays | Process payments on banking days. |
Recurring Date Option (autopay.recurringDate)
Value | Description |
autopay.recurringDate.applyDate | The next AutoPay in the cycle will be scheduled based on the apply date. |
autopay.recurringDate.processDate | The next AutoPay in the cycle will be scheduled based on the process date. |
SchedulingType (autopay.schedulingType)
Value | Description |
autopay.schedulingType.calendarDay | If the payment falls on a non-banking day, process date should be on that day. |
autoapay.schedulingType.bankingDayPrior | If the payment falls on a non-banking day, process date should be adjusted to the prior banking day. |
autopay.schedulingType.bankingDayNext | If the payment falls on a non-banking day, process date should be adjusted to the next banking day. |
Payoff Adjustment (payoffAdjustment)
This does not use a collection, but takes values of 0, 1, or 2.
Value | Description |
0 | Do not process the AutoPay |
1 | Adjust the AutoPay amount to equal the payoff amount. |
2 | Process the AutoPay for the scheduled amount. |