Get Autopays

Use the Get Autopays API endpoint to retrieve the autopays currently scheduled against a customer's line of credit 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 Get Autopays endpoint enables you to retrieve the autopays currently live on a bank account linked to a customer's line of credit account. Use this endpoint to display a customer's scheduled payments, or to retrieve an autopayId before updating or cancelling an autopay with the Update Autopay endpoint.

📘
Note
The loan management system does not supersede an existing autopay when a new one is created, so an account can hold several autopays at once — more than one payment may currently be scheduled. Autopays that have already run, failed, or been cancelled are never included in the response, even though the loan management system keeps them on the account flagged as active.

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

Prerequisites

To integrate calls to the Get Autopays endpoint, you need:

The account_id of the line of credit account. This is the Thredd Account ID, returned when a credit application is approved.
The bank_account_id of the bank account the autopay was scheduled against. Bank accounts are created using the Create Bank Account endpoint.

Example Request

Retrieve the autopays on a bank account by making a GET request to the Get Autopays endpoint.

GET {{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 Response

A successful request returns a 200 HTTP status code with the autopays currently live on the account, most recently created first.

{
  "accountId": "acc_123456",
  "autopays": [
    {
      "autopayId": "ap_789012",
      "status": "scheduled",
      "paymentAmountOption": "statement_balance",
      "amount": null,
      "paymentDate": "2025-02-15",
      "frequency": "monthly"
    },
    {
      "autopayId": "ap_654321",
      "status": "scheduled",
      "paymentAmountOption": "other_amount",
      "amount": "100.00",
      "paymentDate": "2025-02-01",
      "frequency": "one_time"
    }
  ]
}

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

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

Response Fields

Autopay Response Object

Attribute	Description
`accountId`	string. The unique identifier of the line of credit account the autopays belong to.
`autopays`	array. The autopays currently live on the account, most recently created first. See Autopay Object below.

Autopay Object

Attribute	Description
`autopayId`	string. The unique identifier of the autopay. Pass this value to the Update Autopay endpoint to update or cancel it.
`status`	string. The status of the autopay. See Autopay Status Values below.
`paymentAmountOption`	string. Which amount the autopay collects. See Payment Amount Option Values below.
`amount`	string or null. The payment amount. Only set when `paymentAmountOption` is `other_amount` — for every other option, the loan management system calculates the amount at run time.
`paymentDate`	string. The date the payment applies on, in `YYYY-MM-DD` format.
`frequency`	string. How often the autopay repeats. See Frequency Values below.

Autopay Status Values

Value	Description
`scheduled`	The autopay is scheduled and has not yet run.
`completed`	The autopay has run successfully.
`failed`	The autopay attempt failed.
`cancelled`	The autopay was cancelled before it ran.
`unknown`	The status of the autopay could not be determined.

Payment Amount Option Values

Value	Description
`minimum_payment`	Collects the account's current minimum payment.
`statement_balance`	Collects the account's most recent statement balance.
`current_balance`	Collects the account's current balance at the time the autopay runs.
`past_due`	Collects the amount currently past due on the account.
`other_amount`	Collects the specific `amount` on the autopay.

Frequency Values

Value	Description
`one_time`	The autopay runs once and does not repeat.
`weekly`	The autopay repeats every week.
`biweekly`	The autopay repeats every two weeks.
`semi_monthly`	The autopay repeats twice a month.
`semi_monthly_alt`	An alternate twice-a-month schedule.
`monthly`	The autopay repeats every month.
`quarterly`	The autopay repeats every quarter.
`semi_annually`	The autopay repeats every six months.
`annually`	The autopay repeats every year.
`custom`	A custom repeat schedule.

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 2 days ago

Did this page help you?