Administrative APIs | REST

Version:
Download Open API Specification

Update Card Status

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

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

  • cardNumber string

    Either a Card Number or a Card Proxy can be passed in this field. If Card Proxy is used, then the ‘IsProxyCard’ field must be set to ‘True’. When requesting debit card information, provide one of the following: Card Number, Employee/Dependent’s Social Security Number, or Employee/Dependent ID. If multiple fields are provided in addition to the card number, the card number is used.

  • cardStatus enum<string>
    Possible values: New Active TempInactive PermInactive LostStolen
  • statusChangeReason enum<string>

    Reason why the card 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
  • isProxyCard boolean

    Indicates if this is a proxy card.

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

  • pinIssueAddressCode enum<string>
    Possible values: None Cardholder Employer Tpa MBI PrimaryCardholder CardholderShipping EmployerAlternate TPAAlternate
  • notes string