Credit Overview

Introduction to Credit

The Credit Service is a Thredd-managed service that provides access to Thredd's credit capabilities through a unified API.

The service exposes a REST API that supports the full lifecycle of a credit product, from application through to ongoing account servicing. At a high level, the flow is:

• Retrieve available products: Fetch the Financial Products configured for your programme so the applicant can select one.
• Submit an application: Start the origination process, triggering soft credit checks and third-party decisioning.
• Respond to an offer: Receive the offer via webhook and accept or decline on behalf of the applicant.
• Account and card creation: On acceptance, a hard credit check is performed; if approved, a Line of Credit and payment card are created automatically.
• Service the account: Use the Explorer and Payments endpoints to manage the live account and support customer-facing functionality.

For more information about Thredd's credit offering, see Introduction to Credit at Thredd.

API Endpoint Overview

The following API endpoints are available for the Thredd Credit offering:

Application:

• Create (Start) Credit Application: POST /credit/applications​
• Get Application Metadata: GET /credit/applications/metadata
• List Credit Applications: GET /credit/applications
• Respond To Line Of Credit Offer: POST /credit/applications/offers/{offer_id}/response
• Get Credit Application Timeline: GET /credit/applications/{application_id}/timeline
• Submit Pre-Approved Application: POST /credit/applications/pre-approved
• Get Credit Application by ID: GET /credit/applications/{application_id}

Explorer:

• Get Statements by Line of Credit ID : GET /credit/explorer/accounts/{account_id}/statements
• Get Dashboard : GET /credit/explorer/accounts/{account_id}/dashboard
• Get Billing Period Transactions: GET /credit/explorer/accounts/{account_id}/transactions/list
• Get Transaction Details by ID: GET /credit/explorer/accounts/{account_id}/transactions/{transaction_id}
• Get Statement Download URL: GET /credit/explorer/accounts/statements/{statement_id}/download

Accounts:

• Log Payment: POST /credit/accounts/{account_id}/payment/post
• Create Autopay: POST /credit/accounts/{account_id}/bank-accounts/{bank_account_id}/autopay

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.