Credit Bank Account

Use the Credit Bank Account API endpoints to create, retrieve, and delete bank accounts associated with your customers' profiles.

📘

Important

Certain Credit API endpoints are in a draft status and are subject to change without notice. Thredd may modify interfaces, behaviour, and documentation as development continues.

Bank Accounts

The Bank Account endpoints enable you to manage bank accounts (payment profiles) linked to your customers in the system. These endpoints form the payment setup layer of the Credit Service API, allowing you to register bank accounts that can then be used for payments against a customer's line of credit.

📘

More Information

For more information about the Credit Service API, see: Credit Service API Overview.

Bank Account Endpoints

EndpointDescriptionDocumentationMethod
Create Bank AccountCreate a bank account and link it to a customer.Create Bank AccountPOST
List Bank Accounts by CustomerRetrieve a paginated list of a customer's linked bank accounts.List Bank Accounts by CustomerGET
Delete Bank AccountPermanently remove a bank account from a customer's profile.Delete Bank AccountDELETE

Customer Identifier

The Create Bank Account and List Bank Accounts by Customer endpoints require a Thredd customer_id as a path parameter. This is the Thredd Account Holder ID, returned in the response when a credit application is approved. You should store this value and associate it with the relevant customer in your own system.

Pagination

The List Bank Accounts by Customer endpoint returns paginated results and supports the following pagination parameters:

  • pageSize — The number of results to return per page. Default is 50.
  • pageToken — The cursor token for the next page of results. Pass the nextPageToken value returned in the previous response to retrieve the next page. If nextPageToken is null, there are no further pages.

Did this page help you?