Get cards summary

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

Retrieve a summary of all cards associated with a specific participant and their dependents, if applicable. This endpoint is useful for obtaining card details such as status, issue dates, and cardholder information.

Request

Path parameters

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.

Header parameters

Accept-Language enum<string>

Specify the participant’s language preference for the response. Valid options are English (en), Spanish (es), or French (fr). If not specified or if an invalid value is provided, the response defaults to English. Note that if a requested language lacks a translation for a specific field, the English value will be returned.

Possible values: es en fr

Query parameters

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.
filterflag integer <int32>

Determines whether to filter out cards marked as Do Not Issue or in a Permanently Inactive status. Set to true (1) to exclude these cards from the response; set to false (0) to include them.

Response

Response body

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.

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.

Request URL

Authorization Bearer Token

tpaId (Required)

employerId (Required)

participantId (Required)

decrypt

filterflag

No response yet.

No response yet.

Language

Example

[
  {
    "MobileWalletEnabled": false,
    "EmployeeId": "123987123",
    "DependentId": "123987123-01",
    "CardLast4Digits": "0402",
    "CardProxyNumber": "1100054158600402",
    "CardStatusCode": 1,
    "NamePrefix": "",
    "FirstName": "Madison",
    "MiddleInitial": "",
    "LastName": "Test",
    "MailedDate": "        ",
    "CardIssueCde": 2,
    "ActivationDate": "",
    "IssueDate": "20221014"
  },
  {
    "MobileWalletEnabled": false,
    "EmployeeId": "123987123",
    "DependentId": "",
    "CardLast4Digits": "5241",
    "CardProxyNumber": "1100054076395241",
    "CardStatusCode": 2,
    "NamePrefix": "",
    "FirstName": "Rhys",
    "MiddleInitial": "",
    "LastName": "Test",
    "MailedDate": "",
    "CardIssueCde": 3,
    "ActivationDate": "20221011",
    "IssueDate": "20220829"
  }
]

Participant APIs | REST