Get HSA Investment Details

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

Retrieve detailed investment information for a specific Health Savings Account (HSA) associated with a participant, identified by TPA ID, Employer ID, and Participant ID. This operation is useful for obtaining the current investment status and portfolio details of the HSA account.

Request

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 user whose feature information is being retrieved.

Query parameters

flexaccountkey integer <int32>

A system-generated identifier for the benefit account being retrieved, used to specify which account's investment details to fetch.
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

TotalBalance number <double>

Total HSA balance not invested
PortfolioBalance number <double>

Total value of portfolio assets with Devenir
Portfolio array <object>
- Name string
  
  Description of asset category
- Description string
  
  Description of asset category
- MarketValue number <double>
  
  Market value of asset category

TotalBalance number <double>

Total HSA balance not invested
PortfolioBalance number <double>

Total value of portfolio assets with Devenir
Portfolio array <object>
- Name string
  
  Description of asset category
- Description string
  
  Description of asset category
- MarketValue number <double>
  
  Market value of asset category

Request URL

Authorization Bearer Token

tpaId (Required)

employerId (Required)

participantId (Required)

flexaccountkey

decrypt

No response yet.

No response yet.

Language

Example

{
  "TotalBalance": 969.53,
  "PortfolioBalance": 0,
  "Portfolio": [
    {
      "Name": "",
      "Description": "",
      "MarketValue": 0
    },
    {
      "Name": "",
      "Description": "",
      "MarketValue": 0
    },
    {
      "Name": "",
      "Description": "",
      "MarketValue": 0
    }
  ]
}

Participant APIs | REST