Credit Accounts

The Accounts endpoints enable you to record payments and schedule automatic payments against a customer's line of credit account. Use them to build payment features into your customer interface, such as a "make a payment" screen or an autopay settings page.

Accounts Endpoints

The Accounts endpoints can also be viewed in the API Explorer.

Payment Flows

The Accounts endpoints support two ways of paying towards a line of credit.

Logging a Payment Made Outside Thredd

If the customer has already paid through an external channel, such as a cash payment made in person or a check received by mail, record it against the account with the Log Payment endpoint. This endpoint doesn't move any money and isn't tied to a bank account. It only records the payment on the account.

Scheduling an Autopay

To collect a payment from the customer's bank account by ACH transfer, schedule an autopay with the Create Autopay endpoint. Each autopay collects from a bank account linked to the customer, so the bank account must first be created with the Create Bank Account endpoint.

Autopays belong to the line of credit account. When you create an autopay, you send the bank account it collects from in the bankAccountId field of the request body. To move an existing autopay to a different bank account, send the new bankAccountId to the Update Autopay endpoint.

To list the autopays scheduled on a bank account, use the Get Autopays endpoint. Use the autopayId it returns to update or cancel an autopay.

Account Identifier

All Accounts endpoints require a Thredd account_id as a path parameter. This is the unique identifier of the line of credit account, returned when a credit application is approved. Store this value and associate it with the relevant customer in your own system.