Transactions

Overview

The Transactions API provides a detailed ledger of financial activities for a consumer’s benefit plans. This endpoint allows developers to audit contributions, claims, payments, and adjustments within a specific plan year. By default, it offers a historical lookback of up to three years, ensuring comprehensive visibility into a consumer’s spending history.

Key Features

• Flexible Lookbacks: Retrieve the most recent transactions or define specific date ranges for deep-dive auditing.
• Running Balances: Optionally calculate and include the running balance after each transaction to provide a “checkbook” style view.
• Correlation Tracking: Support for X-Request-Id to assist in cross-system troubleshooting and logging.

Use Cases

• Activity Feeds: Populating a “Recent Activity” list in a mobile or web application.
• Statement Generation: Extracting transaction data for a specific date range to generate monthly or quarterly statements.
• Balance Reconciliation: Using the include_running_balance feature to help users understand how specific claims impacted their total available funds.

Scopes & Permissions

Core Concepts

Search Logic & Date Ranges

The API employs a specific priority logic for fetching data:

• Default Behavior: If start_date and end_date are omitted, the system returns up to 200 transactions per plan, looking back three years from today.
• Specific Ranges: If you set number_of_transactions to 0, you must provide both a start_date and end_date (ISO 8601 format).

Running Balance

By setting include_running_balance=true, the API calculates the state of the account at the time of the transaction. This is computationally heavier but provides high value for user-facing ledgers.

Pagination

Standard zero-based pagination applies to the results list.

Error Handling