Accounts Balances And Funding

Core Account Services

1. Funded Account API

The Funded Account API provides account-level data for a consumer’s funded accounts.

• Account Details: Retrieve a consumer’s funded account or accounts.
• Holds: Retrieve holds on a funded account, filtered by hold status.
• Tiered Interest Rates: Retrieve the interest rates that apply to a funded account, optionally scoped by FDIC choice.
• Tax Year Contributions: Retrieve contribution totals for up to four tax years in one request.
• Identity Verification Status: Check a consumer’s IDV status.
• Advance Accounts: Retrieve the advance accounts tied to a funded account.

2. FDIC API

The FDIC API provides FDIC settings at the consumer level.

• Consumer FDIC Settings: Retrieve the FDIC designation settings for a consumer.

3. HSA Reporting API

The HSA Reporting API provides contribution reporting for HSA and CDH accounts, scoped to the partner identified by the bearer token.

• Contribution Details: One record per posted contribution transaction, with filters for employer, participant, tax year, and date ranges.
• Contribution Summaries: One record per participant account, with year-to-date totals and monitoring flags for IRS limit risk and zero contributions.
• Batch Freshness: HSA reporting data comes from a nightly batch load, so responses reflect the latest completed snapshot, not a live position.
• Bounded Queries: HSA reporting endpoints require at least one scoping filter, such as employer_id. Requests without one return 400.

Integration Standards

Security & Authentication

Account operations require OAuth scopes to ensure data privacy and regulatory compliance:

• [scope name]: Required for funded account, interest rate, contribution, and IDV data.
• [scope name]: Required for FDIC consumer settings.
• [scope name]: Required for HSA and CDH contribution reporting.

HSA reporting access is limited to the partner resolved from the bearer token. Each employer_id supplied must belong to that partner’s authorized employer set.

Operational Consistency

• Identifier Standards:consumer_id uses GUID format. Other identifiers, including funded_account_id, participant_identifier, and hsa_account_id, are strings.
• Pagination: HSA reporting endpoints return paginated results. [Confirm parameters, default, and maximum page size.]
• Troubleshooting: Use the X-Request-Id header across all requests for cross-system correlation and error logging. [Confirm this applies to all three groups.]

Global Error Reference