API Credit Lifecycle

This page outlines the end-to-end customer journey and the key endpoints used at each stage of the credit lifecycle.

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

Customer Journey

The following section describes the typical lifecycle of a credit application, from initial product selection through to ongoing account servicing.

1. Retrieve Available Products

Before submitting an application, retrieve the list of financial products configured for your programme. The product ID returned from this call is required when submitting an application.

GET /api/v1/credit/applications/metadata

2. Submit an Application

Two application paths are supported depending on your programme configuration.

Standard Review

Submit a credit application for the selected financial product.

POST /api/v1/credit/applications

When this endpoint is called:

The application is submitted to Thredd and processing begins
Third-party decisioning and identity verification services are invoked
A soft credit check is performed

📘
Note
A soft credit check does not impact the applicant's credit file.

Pre-Approved

If the applicant has already been assessed externally, submit a pre-approved application directly.

POST /api/v1/credit/applications/pre-approved

3. Respond to an Offer

If the application passes initial checks, an offer is generated and delivered to the client via Thredd’s Event Delivery System (EDS). You must respond to the offer on behalf of the applicant.

POST /api/v1/credit/applications/offers/{offer_id}/response

Use this endpoint to record whether the applicant accepts or declines the offer. If no response is recorded, the application is marked as Withdrawn.

4. Credit Decision, Card Issuance, and Account Creation

After the offer is accepted:

A hard credit check is performed.
On successful approval, a payment card is issued by Thredd.

The account is then active and available for use.

5. Service an Active Account

Once the line of credit is active, use the following endpoint groups to support account servicing and customer-facing functionality.

Explorer

Use the Explorer endpoints to retrieve read-only account, transaction, and statement data for dashboards and customer-facing views.

GET /api/v1/credit/explorer/accounts/{account_id}/dashboard

GET /api/v1/credit/explorer/accounts/{account_id}/statements

GET /api/v1/credit/explorer/accounts/{account_id}/transactions/list

GET /api/v1/credit/explorer/accounts/{account_id}/transactions/{transaction_id}

GET /api/v1/credit/explorer/accounts/statements/{statement_id}/download

Accounts

Use the Accounts endpoints to log payments and schedule automatic payments against an active line of credit. Two flows are supported: logging a payment that was already made outside the system (for example, cash or check), and setting up a scheduled automatic payment (autopay) using a linked bank account.

POST /api/v1/credit/accounts/{account_id}/payment/log

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

Updated 1 day ago

Did this page help you?