Participant APIs | REST

Selected Version:
Download Open API File

Get card details

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

Retrieve detailed information about a participant's card, including its effective date, activation date, PIN details, and current status.

Request

Path parameters

Path parameters page anchor
  • 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.

Query parameters

Query parameters page anchor
  • card string Required

    Card Proxy Number. This can be retrieved on the Get Card Summary API.

  • 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

Response body

Response body page anchor
  • 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.

  • 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.

Response Headers 
No response yet.
Response Body 
No response yet.
Request
Response 
{
  "ReissueCard": true,
  "EmployerID": "QBSZXC",
  "EmployeeID": "123987123",
  "DependentID": "",
  "CardEffectiveDate": "20220829",
  "CardExpireDate": "20280630",
  "CardProxyNumber": "1100054076395241",
  "CardLast4Digits": "5241",
  "LastUpdatedDateTime": "2023-01-01T08:00:00Z",
  "PrimaryCard": true,
  "CardStatusCode": "New",
  "UserDefinedField": "",
  "CardStatusReasonCode": 3,
  "ShipmentTrackingNumber": "",
  "ActivationDate": "20221011",
  "CardDesignID": "PAYMENT",
  "MailedDate": "",
  "IssueDate": "20220829",
  "PickDate": 0,
  "IssuedBy": "CARDAGENT",
  "ShippingAddress": "123 Test Road, Clermont, FL 34711",
  "ThermalFrontLogoID": "QCard123",
  "CreationDate": "20220829",
  "PINMailerRequestDate": "",
  "PINMailedDate": "",
  "PINMailerAddress": "123 Test Road, Clermont, FL 34711"
}

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...