HSA

Overview

Retrieve HSA contribution reporting data. HSA enables partners to access contribution details, participant-level summaries, and account status across WEX platforms. It includes operations for contribution transactions, year-to-date summaries with monitoring flags, and [account status]. Use this resource to track contributions by employer and participant, identify participants approaching the IRS limit or who have not yet contributed, and build reporting and monitoring experiences.

Why use the API?

• Modernization: It provides a standardized, clear, and modern RESTful endpoint, making it easier to integrate with current systems.
• Integration: It allows you to easily consume and integrate HSA contribution data, powering your own reporting and monitoring experiences.
• Growth & Innovation: Using our API, you can improve your own products and create a smoother experience for your customers and consumers.

What can the API do?

The HSA API allows you to perform functions related to the partner’s:

• Contribution transactions
• Participant contribution summaries
• IRS limit risk and zero-contribution monitoring
• [HSA and CDH account status, confirm]

Key Features

• Returns one record per posted contribution transaction, filtered by employer, participant, HSA account, tax year, contribution type, funding source, and processed or contribution date ranges.
• Returns one record per participant account, with year-to-date contribution totals and flags for IRS limit risk and zero contributions.
• Scopes every request to the partner identified by the bearer token. Each employer_id must belong to the partner’s authorized employers, or the request returns 403.
• Requires at least one filter on each request so queries stay bounded. Requests without one return 400.
• Applies defaults on contribution details: the current tax year, and the last 90 processed days when no date range is given.
• Reflects the most recent nightly batch load, not a live position.
• Returns results in a consistent order: employer, participant identifier, plan type, then processed date, ascending.

HSA API Operations

The HSA API includes the following operations. Select the API Reference tab to find functional information about each one.

• List HSA Contribution Details
• List HSA Contribution Summaries
• List HSA Contribution Status [confirm name]
• List CDH Contribution Summaries [confirm name]