This request creates an AutoPay on a line of credit account.
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 schedule an AutoPay (or multiple AutoPays) 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.
The ability to create an AutoPay on a line of credit is dependent on AutoPays being enabled in the LineOfCreditSettings. The autopayEnabled field within the LineOfCreditSettings object must be set to 1.
A scheduled AutoPay can fail when it's processed. This can happen if the customer's payment account is invalid or if the selected processor for the payment is incorrect.
This request interacts with Compliance Guardrails.
Compliance Guardrails are a LoanPro feature that helps ensure actions taken on accounts are done so compliantly with lending laws. Once configured, these guardrails are applied to a line of credit program, ensuring all accounts within that program adhere to the same compliance standards.
Guardrails are configurable, allowing you to set rule criteria for which accounts should either result in a warning or an error. If your request attempt is flagged by a guardrail, a
409response code is returned along with one of the following responses:{ "error": { "message": "", "type": "GuardrailEvaluationException", "code": 409 }, "warnings": [ "<p>CARD Act Warning: This is a configurable warning message.</p>" ] }{ "error": { "message": "CARD Act Compliance: This is a configurable error message.", "type": "GuardrailEvaluationException", "code": 409 } }Guardrail flags can be ignored for testing purposes by adding
"ignoreGuardrailWarnings": trueto the payload of this request.
Database
For information about Line of Credit and AutoPay database tables, see the following articles:
Database – AutoPay Main Table (loan_autopay_entity)
Database – Line of Credit Payments (line_of_credit_payment_entity)
Database – Line of Credit Payment Type (line_of_credit_payment_type_entity)
{
"Autopays": {
"results": [
{
"name": "Monthly Statement Balance AutoPay",
"type": "locAutopay.amountType.Total",
"amount": null,
"recurringFrequency": "autopay.recurringFrequency.monthly",
"recurringPeriods": 24,
"applyDate": "2023-12-30",
"processDateTime": "2023-12-29 15:00:00",
"PrimaryPaymentMethod": {
"__id": 4932
},
"isSplit": 0,
"paymentTypeId": 1,
"paymentSplitTypeId": null,
"amountType": "locAutopay.amountType.static",
"recurringDateOption": "autopay.recurringDate.applyDate",
"merchantProcessor": {
"bankAccount": {
"id": 130,
"key": "nacha",
"name": "NACHA",
"default": 0
}
},
"creditCardProcessor": null,
"bankAccountProcessor": 130,
"status": "autopay.status.pending",
"originalProcessDateTime": null,
"processIfCurrent": false,
"chargeServiceFee": 0,
"retryDays": 0,
"retryCount": 0,
"scheduleNextIfFail": 0,
"postPaymentUpdate": 0,
"schedulingType": "autopay.schedulingType.calendarDay",
"daysInPeriod": null,
"lastDayOfMonthEnabled": 0,
"applyLastDayOfMonthEnabled": 0,
"paymentFee": 0,
"paymentMethodAuthType": "payment.echeckauth.WEB",
"chargeOffRecovery": 0,
"active": 1,
"totalBalanceAdjustment": "lineOfCredit.amountExceedsOption.matchTotalBalance",
"mcProcessor": "{\"bankAccount\":{\"id\":130,\"key\":\"nacha\",\"name\":\"nacha\",\"default\":0}}",
"processCurrent": 0,
"baProcessor": 130,
"ignoreGuardrailWarnings": false,
"metadata": {
"keyValue": "NewValue"
}
}
]
}
}