Create Autopay

Creates a single scheduled automatic payment (autopay) for a line of credit account.

To choose the bank account the autopay collects from, send its ID in bankAccountId.

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.

Path Parameters

  • account_id — The unique identifier of the line of credit account.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Early Access

Credit 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.


Path Params
string
required

The unique identifier of the line of credit account.

Body Params

The request body for creating a scheduled automatic payment (autopay).

string
required
length ≥ 1

The unique identifier (UUID) of the bank account the autopay collects from.

string
enum
required

The type of bank account: checking or savings.

Allowed:
string
enum
required

The ACH transfer speed: standard or same_day.

Allowed:
string
enum
Defaults to other_amount

Which amount to collect: minimum_payment, statement_balance, current_balance, past_due, or other_amount.

Allowed:
> 0

The payment amount, as a positive number with up to two decimal places. Required for the other_amount option and rejected for every other option.

string
enum
Defaults to due_date

Which date the payment applies on: due_date (the account's next due date) or specific_date.

Allowed:
date | null

The date on which the payment will apply to the account. Required for the specific_date option and rejected for due_date.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json