Administrative APIs | REST

Version:
Download Open API Specification

Create Card For Dependent

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

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

  • cardEffectiveDate string <date-time>

    Indicates card effective date. If not supplied it, defaults to today’s date. May not be earlier than the current date. YYYYMMDD format.

  • dependentId string

    Dependent's ID as it appears in WCA.

  • dependentSocialSecurityNumber string

    Dependent's current social security number.

  • employeeSocialSecurityNumber string

    Employee's current social security number.

  • expireDate string <date-time>

    Card expiration date. YYYYMMDD format.

  • issueCard enum<string>

    If Conditional, a new card is to be created and issued only if the employee is not currently in possession of a card in any status.

    Possible values: None Conditional DoNotIssue Issue
  • issueDate string <date-time>
  • shippingAddressCode enum<string>
    Possible values: None Cardholder Employer Tpa MBI PrimaryCardholder CardholderShipping EmployerAlternate TPAAlternate
  • 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 the shipping address code field. If no value is specified, the default value setup in system is used. If the value specified doesn’t exist in the system an exception is thrown(error number= 20063).

  • 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