Participant APIs | REST

Version:
Download Open API Specification

Get Account Interval Tracker Details

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

Retrieve detailed information about the account interval tracker for a specific participant, identified by their TPA ID, Employer ID, and Participant ID. This endpoint is useful for obtaining financial tracking data related to a participant's account over specified intervals.

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

  • flexaccountId string

    Optional identifier for a specific flex account. If provided, the response will include details specific to this account.

  • year integer <int32>

    Optional parameter to filter results by calendar year. Provide a 4-digit year (e.g., 2025) to retrieve interval tracker details for that year. Sending 0 will return details from all applicable years.

  • 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

  • array <object>
    • TpaId string
    • FlexAcctId string
    • IntervalType integer <int32>
    • IntervalPeriod string
    • SpendingLimit number <double>
    • DepositLimit number <double>
    • IntervalDeposits number <double>
    • IntervalDisbursed number <double>
    • IntervalRemaining number <double>
    • IntervalBalance number <double>
    • PlanYears array <integer>

      Plan years available under the account

AI Assistant Preview

Generating response...