Read-only endpoints for retrieving accounts, statements, and transactions.
Early AccessCredit 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:
| Endpoint | Description | Documentation | Method |
|---|---|---|---|
| Get Dashboard | Retrieve balances, limits and payment details for an account. | Get Dashboard | GET |
| Get Statements by Line of Credit ID | Retrieve a paginated list of billing cycle statements. | Get Statements by Line of Credit ID | GET |
| Get Billing Period Transactions | Retrieve a paginated list of transactions for a date range. | Get Billing Period Transactions | GET |
| Get Transaction Details by ID | Retrieve the full details of a single transaction. | Get Transaction Details by ID | GET |
| Get Statement Download URL | Retrieve a temporary download link for a statement PDF. | Get Statement Download URL | GET |
| Get Rewards Balance | Retrieve the unredeemed rewards points balance for an account. | Get Rewards Balance | GET |
| Redeem Points | Redeem rewards points as a credit to the account. | Redeem Points | POST |
| Adjust Rewards Points | Increase or decrease the rewards points balance on an account. | Adjust Rewards Points | POST |