Get Future Recurring Payments

https://api.wealthcare.com/participant/services/participant/transactions/getfuturerecurringpayments/{tpaId}/{employerId}/{participantId}

Get future recurring payments.

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.

Response

array <object>
- 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 the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
- ParticipantId string
  
  Employee ID
- ClaimKey integer <int64>
  
  Unique Key to identify the claim details.
- TaskScheduleKey integer <int32>
  
  Unique Key to identify the Recurring Task Schedule.
- Claimant string
  
  The family member for whom the claim applies
- Payee string
  
  Name of the Payee.
- StartDate string <date-time>
  
  Start Date of the Recurring Schedule.
- EndDate string <date-time>
  
  End Date of the Recurring Schedule.
- Type enum<string>
  
  Recurring Claim Type.
  
  Possible values: None HSAOnlinePayment RecurringClaim RecurringExpenses
- FrequencyTypeCode enum<string>
  
  Frequency Type Code.
  
  Possible values: All None Daily Weekly BiMonthly Monthly Quarterly Yearly SemiMonthly BiWeekly Once
- TxnAmt number <double>
  
  Txn Amount.
- TotalNumRecurrences integer <int32>
  
  Total number of Recurrences.
- AcctTypeCode string
  
  Account Type Code.
- AcctTypeDesc string
  
  Custom Description.
- SCC string
  
  Service Category Code.
- RemainingNumRecurrences integer <int32>
  
  Remaining number of Recurrences.
- NextRunDate string <date-time>
  
  Next Run Date of the Recurrence.