Get HSA payment details
Retrieve detailed information about Health Savings Account (HSA) payments for a specific participant, identified by TPA ID, Employer ID, and Participant ID. This endpoint is useful for obtaining payment history and status for HSA transactions.
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.
-
claimKey integer <int32> Required
Unique identifier for the claim associated with the HSA payment. This integer value is required to fetch specific payment details.
-
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
-
PaymentDate string <date-time>
Service start date
-
PayeeName string
Provider name / Payee name
-
PayeeAddress string
Provider address / Payee address
-
AccountDescription string
Product partner name
-
Amount number <double>
Amount of the payment per pay cycle
-
PaymentType integer <int32>
Method for reimbursing an employee or provider for this transaction { Check = 1, DirectDeposit = 2 }
-
PayeePhone string
Provider phone number / Payee phone number
-
Memo string
Memo / Note
-
ErrorCode integer <int32>
Error code
-
ErrorDescription string
Error description
-
PayProvider string
EIN number / Tax ID number
-
TaskSchKey integer <int32>
Unique key identifier for task scheduling
-
ClaimKey integer <int64>
Unique key identifier for claim
-
RecurrenceFrequency enum<string>
Indicates whether the claim will be a recurring claim or not, and what the recurrence is
Possible values:AllNoneDailyWeeklyBiMonthlyMonthlyQuarterlyYearlySemiMonthlyBiWeeklyOnce -
TotalRecurrence integer <int32>
Number of payment that are to be made
-
NextPaymentDate string <date-time>
Date of next payment
-
TaskSchStartDate string <date-time>
The start date for the first recurrence of the claim
-
TaskSchEndDate string <date-time>
The end date for the recurrence
-
TaskScheduleOptions integer <int64>
Payment schedule options { None = 0, StopSchedule = 8, RecurringNumOfPaymentsSet = 16, CompleteSchedule = 32 }
-
UpdateDte string <date-time>
Last update date of payment
-
FlexAcctKey integer <int32>
Unique key identifier for flex account