Create Autopay

Use the Create Autopay API endpoint to schedule an automatic payment against a customer's line of credit account using a linked bank account.

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

The Create Autopay endpoint enables you to schedule a single automatic payment (autopay) against a customer's line of credit account, using a specific bank account linked to the customer. Use this endpoint to set up a scheduled ACH payment. To record a payment that has already been made outside of an automated bank transfer, use the Log Payment endpoint instead.

📘
More Information
For more information about the Accounts endpoints, see: Credit Accounts.

Prerequisites

To integrate calls to the Create Autopay endpoint, you need:

The account_id of the line of credit account to schedule the payment against. This is the Thredd Account ID, returned when a credit application is approved.
The bank_account_id of the bank account to use for the autopay. Bank accounts must first be created using the Create Bank Account endpoint before they can be referenced here.

Example Request

Schedule an autopay by making a POST request to the Create Autopay endpoint.

POST {{baseUrl}}/api/v1/credit/accounts/{account_id}/bank-accounts/{bank_account_id}/payment/autopay

Path Parameters

Parameter	Description
`account_id`	string. Required. The unique identifier of the line of credit account.
`bank_account_id`	string. Required. The unique identifier of the bank account to use for the autopay.

Example Payload

{
  "amount": 0,
  "paymentMethodAccountType": "checking | savings",
  "achType": "standard | same_day",
  "applyDate": "YYYY-MM-DDTHH:MM:SSZ"
}

{
  "amount": 250.00,
  "paymentMethodAccountType": "checking",
  "achType": "standard",
  "applyDate": "2025-02-15T00:00:00Z"
}

Request Fields

Attribute	Description
`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.

ACH Type Values

Value	Description
`standard`	Standard-speed ACH transfer.
`same_day`	Same-day ACH transfer.

Example Response

A successful request returns a 200 HTTP status code confirming the autopay has been scheduled.

📘
Note
If the request contains invalid data or is incomplete, the system returns a 422 HTTP error and details of the validation failure.

{
  "isSuccess": true
}

{
  "detail": "Account mapping not found."
}

{
  "detail": "Bank Account mapping not found."
}

{
  "detail": [
    {
      "loc": ["body", "amount"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Response Fields

Attribute	Description
`isSuccess`	boolean. Indicates whether the operation was successful.

Error Messages

If there is a problem with the request, the response returns one of the following errors:

404 — The account_id or bank_account_id provided does not match an existing account or bank account.
422 — A required field or its value is missing or invalid. The response includes details of the validation failure.

Updated 4 days ago

Did this page help you?