Get Cards

https://api.wealthcare.com/system/Services/Employee/Card/{tpaId}/{employerId}/{employeeId}/List

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.
employeeId string Required

Unique identifier for the employee.

Request body

DependentId string

Dependent's ID as it appears in WCA.
DependentSocialSecurityNumber string

Dependent's current social security number.
EmployeeId string

Employee's ID as it appears in WCA.
EmployeeSocialSecurityNumber string

Employee's current social security number.
CardNumber string

Card number belonging to the debit card.

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.

Min Length:	0
Max Length:	18

TpaId string

A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
VerboseMode boolean
IsProxyCard boolean

Must be set to 'true' if proxy card number is provided in the CardNumber field.
ExtensionData object

Response

array <object>

ReissueEligible boolean
Notes string
PinMailerIssued boolean

Specifies whether or not to issue a PIN Mailer associated with the request debit card. False – Does not issue a PIN Mailer True – Issues a PIN Mailer.
PinRequestedDate string

Date the PIN was requested.
PinMailedDate string

The date the PIN Mailer was mailed to the recipient.
PinMailerAddress string

The address the PIN Mailer was shipped to.
CardProxyNumber string

The debit card’s Card Proxy number. This value is required for retrieving a debit card’s PIN value.
CardEffectiveDate string

The debit card's effective date.
CardNumber string

The card number belonging to the debit card.
CardCurrentStatus enum<string>

Possible values: All New Active TempInactive PermInactive LostStolen
CardholderFirstName string

Cardholder's first name.
CardholderLastName string

Cardholder's last name.
CardholderMiddleInitial string

Cardholder's middle initial.
CardholderId string

Cardholder's ID as it appears in WCA.
DependentCard boolean

Indicates if this is a dependent's card.

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.

Min Length:	0
Max Length:	18

ExpireDate string

Date that the card expires. YYYYMMDD format.
IssueCardCode enum<string>

Possible values: None DoNotIssue Issue Sent Conditional Mailed Waiting
IssueDate string

Date that the card is issued. YYYYMMDD format.
ShippingAddressCode enum<string>

Possible values: None Cardholder Employer Tpa MBI PrimaryCardholder CardholderShipping EmployerAlternate TPAAlternate
TpaId string

A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
LastUpdateDate string <date-time>
StatusChangeReason enum<string>

Reason why the card's status was changed.

Possible values: InitialCardIssuance IVR None CardholderCalledtoActivate EmployeeTerminated EligibilityChange PendingCardholderReimbursement EmployerTerminated CardholderRequestedChange EmployerRequestedChange CardholderReportedCardStolen CardholderReportedCardLost CardNotReceived EmployerRequestedChangeForLostOrStolen EmployeeTerminatedForPermInactive EligibilityChangeForPermInactive IVRForLostStolen AutoActivationAndDeactivation ReceiptNotificationAutoActivation ReceiptNotificationAutoDeactivation ChangedByCardholder ExpiredCard IVRForActiveCards IVRForPICards IVRSystem IVRsystem ReturnedMailCardForwardingProhibited ReturnedMailInvalidAddressFormat
ShippingExpediteCode enum<string>

Possible values: None Standard OverNight BulkOverNight
AlternateAddressName string

This specifies an alternate address for administrator or employer, depending upon TPAAlternate or EmployerAlternate specified in shipping address code field.
CardType string

Returns Payment Card or Combo Card data.
PickDate string

The processed date within the .psi file.
IssueBy string

The user ID that created the card.
ShippingAddress string

The street address for the ShippingAddressCode field that is displayed on the Card screen.
MailedDate string

The date the card was mailed.
ActivationDate string

The date the card was activated.
ThermalLogoId string

If it was used on the card, the Thermal Logo (Front) Description is returned.
ExtensionData object