Explorer

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

The Explorer endpoints provide read-only access to account data for a customer's line of credit. Use these endpoints to power customer-facing account management experiences, including account dashboards, billing statements, and transaction history.

The Rewards endpoints enable you to integrate a points-based rewards proposition into your credit program. Use these endpoints to retrieve points balances and transaction history for display in your customer interface, and to process point redemptions and additions on demand.

The following API endpoints are available for Thredd Credit Explorer:

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

Get Rewards Balance: GET
/credit/accounts/{account_id}/rewards/balance
Redeem Points: POST
/credit/accounts/{account_id}/rewards/redeem