Participant APIs | REST

Version:

Download Open API Specification

Get cards summary

https://api.wealthcare.com/participant/services/participant/cards/summary/{tpaId}/{employerId}/{participantId}

This operation returns information for all cards associated with a participant and their dependents if applicable.

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

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
filterflag integer <int32>

if true (1): Cards marked as Do Not Issue or in a Permanently Inactive status will be filtered from the response (i.e., not included in the response) if false (0): Cards marked as Do Not Issue or in a Permanently Inactive status will not be filtered from the response (i.e., will be included in the response)

Response

array <object>
- MobileWalletEnabled boolean
  
  True if Mobile Wallet is enabled for the card.
- EmployeeId string
  
  The Employee Id of the card of the employee
- DependentId string
  
  Returns the dependent ID if the card was issued to a dependent. Returns null if the card belongs to an employee
- CardLast4Digits string
  
  The last four digits of the card
- CardProxyNumber string
  
  The proxy number of the card
- CardStatusCode integer
  
  A numerical value indicating the status: 1 = New, 2 = Active, 3 = Temp Inactive, 4 = Perm Inactive, 5 = Lost/Stolen
- NamePrefix string
  
  The prefix of cardholder's name. Valid values are: Mr., Mrs., Ms., Dr., Rev.
- FirstName string
  
  The cardholder's first name
- MiddleInitial string
  
  The cardholder's middle name initial
- LastName string
  
  The cardholder's last name
- MailedDate string
  
  The date the card was mailed on. The date format is yyyymmdd.
- CardIssueCde integer
  
  A code indicating the issue status of the card: 1 = Do Not Issue, 2 = Issue, 3 = Sent, 4 = Conditional, 5 = Mailed, 6 = Waiting
- ActivationDate string
  
  The date the card was activated. Returns an empty value if the card has not been activated; returns yyyymmdd when the card has been activated.
- IssueDate string
  
  The date the card was issued on. The date format is yyyymmdd.