Creates a single or monthly recurring automatic payment (autopay) for a line of credit account.
To choose the bank account the autopay collects from, send its ID in bankAccountId.
By default, the autopay is a single payment. To create a monthly recurring autopay, set autopayType to recurring and enter the number of monthly payments in recurringPeriods.
The payment amount is either a specific amount, or an amount the lending system calculates: the minimum payment, statement balance, current balance or past due amount. Set this with paymentAmountOption.
By default, the payment applies on the account's next due date. To use a different date, set paymentDateOption to specific_date and enter the date in applyDate. If the account has no next due date and you use due_date, Thredd returns a 400 error.
The ACH transfer speed defaults to standard. To use same-day ACH, set achType to same_day.
Thredd schedules the payment for processing three calendar days before its apply date. The response returns the ID of the new autopay.
Note: type has been renamed achType, and paymentMethodAccountType is no longer accepted. Requests that include either field are rejected.
Path Parameters
account_id— The unique identifier of the line of credit account.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Early AccessCredit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.