Participant APIs | REST

Version:

Download Open API Specification

Get the ineligible charge balance notification

https://api.wealthcare.com/participant/services/repayment/balance/alert/{tpaId}/{employerId}/{participantId}

Get the ineligible charge balance notification

Path parameters

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

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

Possible values: es en fr

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
planYear enum<string>

Plan Year 0: All, 1: Current Year, 2: Previous Year

Possible values: None ALL Current Previous Future Active CurrentAndFuture

Response

BalanceDue number <double>

Balance Due
IneligibleChargeBalanceMessage string

Ineligible Charge Balance Message