Thredd Credit API Overview

Thredd Credit API Overview

The Thredd Credit API enables clients to build customer-facing mobile and web applications that enable customers to:

• Apply for and submit line of credit applications.
• Retrieve and track credit applications throughout the origination process.
• View account dashboard information, including balances, credit limits, and payment details.
• Retrieve transaction history and individual transaction details.
• Retrieve billing statements.
• Add, view, and remove bank account details linked to a customer account.
• Make immediate or scheduled payments towards a credit account balance.

Use Cases for Credit API Endpoints

These endpoints support developers in building customer-facing screens for front-end user interfaces, mobile apps, and web applications. For example, you could build screens that enable users to:

• View an account summary dashboard, including balances, available credit, and payment due dates
• View a list of transactions for a billing period.
• View statement summaries.
• Download PDF copies of statements.
• Add and remove bank accounts linked to a customer account.
• Make a payment toward an account balance using a stored bank account.

Base URL

All endpoints are available under the following base path: /api/v1/credit/

System of Record Structure

A customer account represents the line of credit that a customer has been approved for following a successful credit application. The account tracks credit limits, balances, and all financial activity associated with the line of credit.

All transactions are tied to the account and include card-initiated activity such as purchases and cash advances, as well as system-generated activity such as interest charges and fees.

Customers

Customers (also known as account holders) are the individuals using the credit product provided by Thredd clients. A customer record is created as part of the approved application flow and is central to how accounts and products are associated within the Thredd platform. Customer records support compliance with KYC (Know Your Customer) and GDPR (General Data Protection Regulation) requirements.

Application Endpoints

The Application endpoints support the full credit origination flow, from retrieving available products through to submitting an application, responding to an offer, and tracking application status. Use these endpoints to build a credit application journey into your user interface.

For more information about the application process, see Credit Applications and Origination. The Application endpoints can also be viewed in the API Explorer.

Explorer Endpoints

The Explorer endpoints provide read-only access to account, transaction, and statement data. Use these endpoints to build customer-facing screens that display account activity and billing history.

For more information about the Explorer endpoints, see Credit Explorer. The Explorer endpoints can also be viewed in the API Explorer.

Accounts Endpoints

Accounts Endpoints. The Accounts endpoints enable clients to log payments and schedule automatic payments against a line of credit account. Use these endpoints to record a payment made outside the system, or to set up a scheduled automatic payment (autopay) using a linked bank account.

For more information about the Accounts endpoints, see Credit Accounts. The Accounts endpoints can also be viewed in the API Explorer.