This request edits an existing AutoPay.
Click here to learn more about this request
AutoPays allow users to schedule automatically processed payments. Note the following when using this request:
This request will edit an existing AutoPay logged on an account. There is a wealth of configuration settings available, and we recommend taking some time to look at each parameter in the payload.
This request is sent through the Loans endpoint, so the __id and __update parameters are required in the Autopays object for the changes to take place.
A scheduled AutoPay may fail when it's processed. This may happen if the customer's payment account is invalid or if the selected processor for the payment is incorrect.
For an example of how AutoPays work within the UI, take a look at our Scheduling a New AutoPay article.
Database
For information regarding AutoPay database tables, take a look at the following articles:
Database – AutoPay Main Table (loan_autopay_entity)
Database – Defaults Autopay (defaults_autopay)
Database – Holding Account Autopay Info (holding_account_autopay_entity)
{
"Autopays": {
"results": [
{
"__id": 265,
"__update": true,
"name": "Updated AutoPay Name",
"type": "autopay.type.single",
"paymentExtraTowards": "payment.extra.periods.next",
"amountType": "autopay.amountType.static",
"paymentType": 1,
"chargeServiceFee": false,
"processCurrent": true,
"retryDays": 0,
"postPaymentUpdate": false,
"methodType": "autopay.methodType.echeck",
"recurringFrequency": "autopay.recurringFrequency.monthly",
"recurringDateOption": "autopay.recurringDate.processDate",
"schedulingType": "autoapay.schedulingType.bankingDayPrior",
"scheduleNextIfFail": 0,
"processDateCondition": "bankingDays",
"payoffAdjustment": false,
"chargeOffRecovery": false,
"processZeroOrNegativeBalance": true,
"recurringPeriods": 1,
"lastDayOfMonthEnabled": false,
"primaryPaymentMethodId": 416,
"paymentMethodAccountType": "bankacct.type.checking",
"paymentMethodAuthType": "payment.echeckauth.WEB",
"ccProcessor": 125,
"baProcessor": 129,
"amount": 10,
"processDateTime": "2022-04-28 06:00:00",
"applyDate": "2022-04-29",
"metadata": {
"newKey": "NewValue"
}
}
]
}
}