Create Autopay

Creates a single scheduled automatic payment (autopay) for a line of credit account, identified by the account ID, using a specific bank account linked to the customer.

Path parameters

  • account_id (string): The unique identifier (UUID) of the account.
  • bank_account_id (string): The unique identifier of the bank account to use for the autopay.

Request body fields

  • amount (number or string, required): The payment amount, as a positive number with up to two decimal places.
  • paymentMethodAccountType (string, required): The type of bank account. Possible values: checking, savings.
  • achType (string, required): The ACH transfer speed. Possible values: standard, same_day.
  • applyDate (string, required): The date and time on which the payment applies to the account, in ISO 8601 date-time format.
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
string
required
Body Params

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

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