Get HSA Account Summary

https://beta.api.wealthcare.com/participant/services/participant/accounts/hsasummary/{tpaId}/{employerId}/{participantId}

Retrieve a summary of a participant's Health Savings Account (HSA), including contributions, balances, and investment details. This endpoint is essential for obtaining up-to-date financial information regarding a participant's HSA.

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.
employerId string Required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
participantId string Required

Unique identifier for the participant whose features are being queried.

Query parameters

flexaccountId string Required

A unique identifier for the flex account, used to retrieve specific account details.
decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

Response

HSACurrentBalance number <double>

Ledger Balance +/- Memo Posts Balance (Displayed as "available balance" in WealthCare Admin)
CashAndEquivalents number <double>

Cash and Equivalents Market Value as determined by the system for tax reporting purposes.
FixedIncome number <double>

Only Applies to Devenir Trust Accounts. Fixed Income Market Value
EquitiesAndMutualFunds number <double>

Only Applies to Devenir Trust Accounts. Equities and Mutual Funds Market Value
Category1Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 1 Description
Category1Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 1 Value
Category2Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 2 Description
Category2Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 2 Value
Category3Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 3 Description
Category3Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 3 Value
Category4Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 4 Description
Category4Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 4 Value
Category5Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 5 Description
Category5Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 5 Value
Category6Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 6 Description
Category6Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 6 Value
Category7Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 7 Description
Category7Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 7 Value
Category8Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 8 Description
Category8Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 8 Value
Category9Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 9 Description
Category9Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 9 Value
Category10Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 10 Description
Category10Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 10 Value
Category11Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 11 Description
Category11Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 11 Value
Category12Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 12 Description
Category12Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 12 Value
Category13Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 13 Description
Category13Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 13 Value
Category14Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 14 Description
Category14Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 14 Value
Category15Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 15 Description
Category15Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 15 Value
Category16Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 16 Description
Category16Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 16 Value
Category17Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 17 Description
Category17Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 17 Value
Category18Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 18 Description
Category18Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 18 Value
Category19Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 19 Description
Category19Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 19 Value
Category20Desc string

Only Applies to Devenir Trust Accounts. Portfolio Category 20 Description
Category20Value number <double>

Only Applies to Devenir Trust Accounts. Portfolio Category 20 Value
HSAProductPartnerName string

Product Partner / HSA Banking Partner Name
PortfolioBalance number <double>

The total amount of the participant's investment account as of prior day close.
TotalHSABalance number <double>

Total HSA Balance before preauth/hold balance
PendingTrades number <double>

Pending Trades Amount
TotalAvailabletoSpend number <double>

Total available for spending HSA Current Balance + Cash And Equivalents + PendingTrades
MinimumBalanceRqdinHSAAcct number <double>

Minimum Balance the participant must maintain in their HSA cash balance - only amounts above this may be transferred to investments (subject to the minimum)
MinimumBalToInvestInTrustAcct number <double>

Minimum Balance the participant must have in their cash has balance in order to invest in an investment account. This value is set at the HSA Bank Partner level
TotalAvailabletoInvest number <double>

Total available for investing. Total available to Spend - Minimum balance required in HSA account
CurrentYearContributions number <double>

Total current year HSA contribution amount for IRS reporting
CurrentYearTotContributions number <double>

Total current year HSA contribution amount
CurrentYearRolloverContributions number <double>

Current Year Rollover Contributions. Note: Rollover Contributions are non-resportable as Contributions for the 5498-SA.
CurrentYearDistributions number <double>

HSA Current Year Distributions
CurrentYearInterestPaid number <double>

Current Year Interest Paid
PriorYearContributions number <double>

Prior Year Contribution amount for IRS reporting
PriorYearRolloverContributions number <double>

HSA Prior Year Rollover Contributions
PriorYearDistributions number <double>

HSA Prior Year Distributions (1099-SA)
RemainingBalanceAmt number <double>

Remaining Balance Amount -- no longer used
SpentAmt number <double>

Spent Amount -- no longer used
ExternalAcctId string

HSA bank account number
TrustAcctNum string

Investment account number
YourContributionsYTD number <double>

Accountholder Contributions YTD Total Contributions YTD - Employer Contributions YTD
EmployerContributionsYTD number <double>

Employer Contributions YTD
TotalContributionsYTD number <double>

Total Contributions YTD
EmployerPerPayPeriodAmt number <double>

Amount the employer chose to deposit to the cardholder account each pay period.
EmployeePerPayPeriodAmt number <double>

Amount employee elected to deposit to the account each pay period
YourPriorYearContributions number <double>

Accountholder Prior Year Contributions Total Prior Year Contributions - Employer Prior Year Contributions
EmployerPriorYearContributions number <double>

Employer prior year contributions
TotalPriorContributions number <double>

Total prior year contributions
CurrYrSingleLimit number <double>

HSA contribution Single Limit for the calendar
CurrYrFamilyLimit number <double>

HSA contribution Family Limit for the calendar
CurrYrCatchUpContribution number <double>

The Current Year IRS allowed amount for catch-up contributions.
PriorYrSingleLimit number <double>

The IRS set limit for Contributions for singles the prior tax year.
PriorYrFamilyLimit number <double>

The IRS set limit for Contributions for Family plans in the the prior tax year.
PriorYrCatchUpContribution number <double>

The IRS set limit for Catch Up Contributions for the prior tax year.
CurrentYear integer <int32>

The Current Tax Year for the account
IsTransferBlocked boolean

Returns whether or not transfers to the investment account are blocked
TransferBlockedExpDte string <date-time>

Returns the date which investment transfers will no longer be blocked