Participant APIs | REST

Version:
Download Open API Specification

Get Account Interval Tracker Details

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

Get Account Interval Tracker Details

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with 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

    Participant Id

  • flexaccountId string Required

    A 10-character string representing an internal key assigned to a benefit account in the WCA system, used to uniquely identify the account. This value is left-padded with 0s, i.e., "0001699940".

  • year integer <int32>

    If sent, only interval tracker details in that calendar year will be included. This should be a 4-digit year (i.e., 2025). If 0 is sent, interval tracker details from all applicable years will be sent.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • array <object>
    • TpaId string

      A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

    • FlexAcctId string

      A 10-character string representing an internal key assigned to a benefit account in the WCA system, used to uniquely identify the account. This value is left-padded with 0s, i.e., "0001699940".

    • IntervalType integer <int32>

      (None = 0, Month = 1, Year = 2, Quarter = 3)

    • IntervalPeriod string

      Displays the benefit period the row represents

    • SpendingLimit number <double>

      Displays the maximum allowable spend for the selected interval. The behavior varies based on the limit type selected in benefit plan level

    • DepositLimit number <double>

      Maximum amount of contributions or deposits allowed for a participant within a specific benefit interval

    • LimitType string

      Displays how Spending limits are applied whether to both deposits and transactions, only to deposits, or only to transactions based on the selected configuration at plan level.

    • Contributions number <double>

      Displays the scheduled contributions or payroll-based deposits made during the selected interval.

    • AdditionalDeposits number <double>

      Shows any rollover amounts, employer manual deposits, or special one-time funding during the interval.

    • SpendingLimitForTheInterval number <double>

      Displays the maximum allowable spend for the selected interval. The behavior varies based on the deposits made into the account. If the Transaction - Total Contributed option is selected, the user is permitted to spend the entire amount deposited within that interval.

    • TotalSpent number <double>

      Shows the total amount of approved claims or card transactions with service dates that fall within the interval.

    • SpendingLimitRemaining number <double>

      Displays the remaining spendable amount for the interval.Shown as null if no spending limit is defined.

    • TotalAccountBalance number <double>

      Reflects the total account balance, including all prior and current contributions, deposits, and unspent funds. This column is shown as N/A when the Spending Limit Type is set to Total Contributed, since rollover is not applicable.

    • PlanYears array <integer>

      Plan years available under the account