Credit Explorer

The Credit Explorer endpoints enable you to retrieve account, statement, and transaction data for your customers' line of credit accounts. These endpoints form the read layer of the Credit Service API, giving you access to the information you need to build account dashboards, display transaction history, and surface billing statements within your own user interface.

Most Explorer endpoints are read-only. They return the current state of an existing line of credit account without changing anything, so you can safely poll or refresh them as often as your user interface needs. The exceptions are the Redeem Points and Adjust Rewards Points endpoints, which change the customer's rewards points balance.

This page provides an overview of:

• What each Explorer endpoint returns, and the kind of screens it's typically used to build
• How the endpoints relate to each other when building a full account management experience
• The account and statement identifiers you need, and how pagination works across the group

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.

The Explorer endpoints can also be viewed in the API Explorer.

What You Can Build With Explorer

Explorer data typically powers four kinds of customer-facing screens:

• An account summary or dashboard — current balance, available credit, minimum payment due, due date, and a breakdown of purchase and cash advance buckets. This is what Get Account Dashboard returns.
• A billing history view — a list of past billing cycle statements, each with its own balances and due date, with the ability to download a PDF copy of any statement. This is covered by Get Account Statements together with Get Statement Download URL.
• A transaction history view — a scrollable, filterable list of transactions for a billing period, with the ability to drill into any single transaction for full merchant and authorization details. This is covered by Get Account Transactions together with Get Transaction Details. For rewards-enabled products, each transaction also includes the rewards points it earned.
• A rewards view — the customer's points balance, with the option to redeem points. This is covered by Get Rewards Balance and Redeem Points. To correct a balance, use Adjust Rewards Points.

Explorer Endpoints at a Glance

Building an Account Management Experience

A typical account management screen combines several Explorer endpoints. Here's how they usually fit together:

1. Load the dashboard first. Call Get Account Dashboard to get the current balance, available credit, payment due date, and bucket-level breakdown (Purchases and Cash Advances). This is usually the first thing a customer sees when they open their account.
2. Show recent activity. Call Get Account Transactions for the current billing period to populate a transaction list. Use the statuses query parameter (which accepts active, reversed, dispute, settled, or pending) to scope results to only the transaction statuses relevant to your view.
3. Let customers drill into a transaction. When a customer taps a transaction, call Get Transaction Details with its transaction_id to show merchant name, category, billing cycle, and authorization amount.
4. Surface billing history. Call Get Account Statements to list past billing cycles with their balances and due dates.
5. Let customers download a statement. Each statement includes a statementId field. Pass its value as the statement_id path parameter on Get Statement Download URL to get a time-limited PDF link — request this on demand rather than caching it, since the URL expires.

   📘

   Note

   Get Statement Download URL takes a statement_id, not an account_id. You always retrieve this from a statement's statementId field returned by Get Account Statements first — there's no way to construct or guess a valid statement ID.

Account Identifier

All Explorer endpoints except Get Statement Download URL require a Thredd account_id as a path parameter. This is the unique identifier of the line of credit account, returned in the response when an application is approved and an account is created. You should store this value and associate it with the relevant customer in your own system.

Pagination

The Get Account Statements and Get Account Transactions endpoints return paginated results. Both endpoints support the following pagination parameters:

• pageSize — The number of results to return per page. Defaults to 50 if not specified.
• pageToken — The cursor token for the next page of results. Pass the nextPageToken value returned in the previous response to retrieve the next page. If nextPageToken is null, there are no further pages.
  Both endpoints also return results in descending order, so the first page you retrieve is always the most recent data — the latest statement, or the most recent transactions.

Date Filtering

Get Account Statements and Get Account Transactions both accept optional fromDate and toDate query parameters, in YYYY-MM-DD format, so you can scope results to a specific range — for example, a single billing cycle or calendar month.