Get Card Suspension Threshold Information of Employee
Retrieve the card suspension threshold information for a specific employee, including their balance due and card suspension status. This endpoint is useful for monitoring participant eligibility and managing card access based on outstanding balances.
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.
Response
-
TpaId string
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
EmployerId string
Unique identifier for the employer. Note: When an employer is created, WealthCare Admin assigns the 3-character prefix; you assign the remaining characters.
-
ParticipantId string
Employee ID for the participant
-
BalanceDue number <double>
When a participant’s debit card transaction is marked as ineligible, or if a reimbursement is issued which is later reversed, the ineligible or reversed amount is tracked as a ‘balance due’. This field returns that amount.
-
ThresholdAmt number <double>
Card access is suspended for this plan for participants who maintain a balance due above the specified threshold, until it is repaid.