Participant APIs | REST

Selected Version:
Download Open API File

Get HSA Account Summary

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

Retrieve the Health Savings Account (HSA) summary for a specific participant, including details such as contributions, balances, and IRS limits. This endpoint is useful for obtaining a comprehensive overview of a participant's HSA activity and status.

Request

Path parameters

Path parameters page anchor
  • 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 user whose feature information is being retrieved.

Query parameters

Query parameters page anchor
  • 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, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Response

Response body

Response body page anchor
  • 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

  • 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

Response Headers 
No response yet.
Response Body 
No response yet.
Request
Response 
{
  "HSACurrentBalance": 969.53,
  "CashAndEquivalents": 0,
  "FixedIncome": 0,
  "EquitiesAndMutualFunds": 0,
  "Category1Desc": "",
  "Category1Value": 0,
  "Category2Desc": "",
  "Category2Value": 0,
  "Category3Desc": "",
  "Category3Value": 0,
  "Category4Desc": "",
  "Category4Value": 0,
  "Category5Desc": "",
  "Category5Value": 0,
  "Category6Desc": "",
  "Category6Value": 0,
  "Category7Desc": "",
  "Category7Value": 0,
  "Category8Desc": "",
  "Category8Value": 0,
  "Category9Desc": "",
  "Category9Value": 0,
  "Category10Desc": "",
  "Category10Value": 0,
  "Category11Desc": "",
  "Category11Value": 0,
  "Category12Desc": "",
  "Category12Value": 0,
  "Category13Desc": "",
  "Category13Value": 0,
  "Category14Desc": "",
  "Category14Value": 0,
  "Category15Desc": "",
  "Category15Value": 0,
  "Category16Desc": "",
  "Category16Value": 0,
  "Category17Desc": "",
  "Category17Value": 0,
  "Category18Desc": "",
  "Category18Value": 0,
  "Category19Desc": "",
  "Category19Value": 0,
  "Category20Desc": "",
  "Category20Value": 0,
  "HSAProductPartnerName": "Quane Bank HSA",
  "PortfolioBalance": 0,
  "TotalHSABalance": 969.53,
  "PendingTrades": 0,
  "TotalAvailabletoSpend": 969.53,
  "MinimumBalanceRqdinHSAAcct": 500,
  "MinimumBalToInvestInTrustAcct": 501,
  "TotalAvailabletoInvest": 469.53,
  "CurrentYearContributions": 1000,
  "CurrentYearTotContributions": 1000,
  "CurrentYearRolloverContributions": 0,
  "CurrentYearDistributions": -112,
  "CurrentYearInterestPaid": 0.03,
  "PriorYearContributions": 0,
  "PriorYearRolloverContributions": 0,
  "PriorYearDistributions": 0,
  "RemainingBalanceAmt": 0,
  "SpentAmt": 0,
  "ExternalAcctId": "29000000638",
  "TrustAcctNum": "eOgRNWLdC9tiPoD3MrEImA==",
  "YourContributionsYTD": 1000,
  "EmployerContributionsYTD": 0,
  "TotalContributionsYTD": 1000,
  "EmployerPerPayPeriodAmt": 10000,
  "EmployeePerPayPeriodAmt": 0,
  "YourPriorYearContributions": 0,
  "EmployerPriorYearContributions": 0,
  "TotalPriorContributions": 0,
  "CurrYrSingleLimit": 3650,
  "CurrYrFamilyLimit": 7300,
  "CurrYrCatchUpContribution": 1000,
  "PriorYrSingleLimit": 3600,
  "PriorYrFamilyLimit": 7200,
  "PriorYrCatchUpContribution": 1000,
  "CurrentYear": 2022,
  "IsTransferBlocked": false,
  "TransferBlockedExpDte": "2023-01-01T08:00:00Z"
}

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...