Get card details

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

Retrieve detailed information about a participant's card, including effective dates, activation status, and card status. This endpoint is essential for verifying card details and understanding the current status of a participant's card.

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 whose features are being queried.

Query parameters

card string Required

The Card Proxy Number, which can be obtained from the Get Card Summary API. This parameter is required to identify the specific card details being requested.
decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

Response

ReissueCard boolean

This returns true if this card was a reissue or replacement; false if this is a brand new card.
EmployerID string

A system generated ID used to identify a specific employer in WCA
EmployeeID string

The employee ID the card was issued to, or the employee ID associated with the dependent to whom the card card was issued to
DependentID string

Returns the dependent ID if the card was issued to a dependent. Returns null if the card belongs to an employee
CardEffectiveDate string

The date the card is first effective. Date format is yyyymmdd.
CardExpireDate string

Card Expire Date
CardProxyNumber string

Card Proxy Number
CardLast4Digits string

The last four digits of the card number
LastUpdatedDateTime string <date-time>

The date/time the card was last updated. Format is Epoch Unix Timestamp.
PrimaryCard boolean

Primary Card Indicator (True (1) or False (0))
CardStatusCode enum<string>

The Card status Code: New = 1, Active = 2, TempInactive = 3, PermInactive = 4, LostStolen = 5

Possible values: All New Active TempInactive PermInactive LostStolen
UserDefinedField string

Custom employee level field that can be used for internal needs, WCA does not use this field.
CardStatusReasonCode integer <int32>

Used in combination with the card status code to indicate how/why the card was moved to that status.
ShipmentTrackingNumber string

Shipment Tracking Number (FedEx or USPS Tracking Number depending on shipping type)
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.
CardDesignID string

A system generated ID to identify the template for the card design.
MailedDate string

The date the card was mailed. Format is yyyymmdd.
IssueDate string

The issue date of the card. Format is yyyymmdd.
PickDate integer <int32>

Legacy Field - do not use
IssuedBy string

Will always return the value CARDAGENT
ShippingAddress string

The address that the card was shipped to.
ThermalFrontLogoID string

The thermal front logo ID printed on the card
CreationDate string

The date the card was created. Format is yyyymmdd.
PINMailerRequestDate string

The date the PIN Mailer was requested on.
PINMailedDate string

Date that a PIN mailer was mailed on.
PINMailerAddress string

The address the PIN Mailer was mailed to.