Autopay

In previewMode=true, the loan doesn't change, and no changes are saved to the database.

true - the Autopay payments will be aligned and processed on the loan's due dates.

false - the Autopay payments schedule will be different from the loan's due dates schedule.

If isAlignedToDueDates=false then paymentFrequency and specificDays must be provided.

If the frequency and specific days of autopay matches the loan, we assume that it is isAlignedToDueDates=true.

The Autopay payments frequency.

Specific days designate the day(s) that due dates will fall on. The allowed values for specific day(s) depends on the paymentFrequency.

weekly - provide one number in the valid range 1-7. 1=Monday...7=Sunday.

For example: [1].

everyTwoWeeks - provide two inputs. The first input (required) is an integer in the valid range 1-7. 1=Monday...7=Sunday.

The second input is a date that indicates when to start the cycle. If the second input is not passed, the system will default to the first valid start date based on the first input (the day of week passed in). If this date is provided then it can override the minimum due date gap specified on the loan type.

For example: [1, "2020-09-16"].

twiceMonthly - provide two numbers in the valid range 1-31. 1=first day of a month. Use 31 to indicate the last day of a month.

For example: [1, 15] or [15, 31].

monthly - provide one or two numbers, depending on the loan type periodCalculationType configuration:

• If periodCalculationType=dueDate, then provide one number in the valid range 1-31. This is the recurring due date. 1=first day of a month. Use 31 to indicate the last day of a month. For example: [1].
• If periodCalculationType=statementDate, then provide one number in the valid range 1-31. This is the recurring statement date. 1=first day of a month. Use 31 to indicate the last day of a month. For example: [1].
• If periodCalculationType=fixedStatementAndDueDates, then provide two numbers. First number represents a recurring statement date and the valid range is 1-31. Use 31 to indicate the last day of a month. Second number represents a recurring due date and the valid range is 1-28. Two numbers must be different. For example: [1, 15] - statements are on 1st and due dates are on 15th. Notes:
  • If the due date precedes the statement day, it's pushed to the next month. For example: [20, 10] and today is Oct 1, 2024. The first statement date is Oct 20, 2024 and the first due date is Nov 10th.
  • For February in non-leap years, if the statement date is ≥ 29 and the due date is 28, the statement date becomes March 1st.

singleTerm - provide one number to indicate duration as a number of calendar days or provide a valid calendar date in the future. This option is only valid for use on the installment type and at loan origination. For example: [90] or ["2020-09-16"].

For weekly, everyTwoWeeks, twiceMonthly, monthly: If specificDays is left null, then the system will calculate due dates according to the paymentFrequency relative to the origination or activation date (or use existing specific days in the case of change due date).

For singleTerm: The specificDays is mandatory.

The payment instrument ID with which this autopay plan will be charged through.

The document ID for the signed autopay agreement. Required if previewMode=false.

An identifier for an existing case.