Get the ineligible charge balance notification
Retrieve notifications regarding ineligible charge balances for a specific participant, identified by TPA ID, Employer ID, and Participant ID. This operation is useful for monitoring and managing participant balances that may not be eligible for repayment.
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.
-
Accept-Language enum<string>
Indicates the participant’s preferred language for response messages. The API will return text in the specified language, defaulting to English if not provided or if an invalid value is sent. Note that if a requested language lacks a translation for a specific field, the English text will be returned.
Possible values:esenfr
-
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.
-
planYear enum<string>
Specifies the plan year for which to retrieve balance notifications. Options include: 0 for all years, 1 for the current year, 2 for the previous year, and other specific designations.
Possible values:NoneALLCurrentPreviousFutureActiveCurrentAndFuture
Response
-
BalanceDue number <double>
Balance Due
-
IneligibleChargeBalanceMessage string
Ineligible Charge Balance Message