Participant APIs | REST

Version:
Download Open API Specification

Get HSA Investment Details

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

Retrieve detailed investment information for a specific HSA account, identified by TPA ID, Employer ID, and Participant ID. This endpoint is useful for obtaining the current balance and portfolio details of HSA investments managed by Devenir.

Request

  • 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.

  • flexaccountkey integer <int32>

    A system-generated ID for the benefit account being retrieved, which helps to uniquely identify the specific account within the system.

  • 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

  • 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

AI Assistant Preview

Generating response...