Add Employer

https://api.wealthcare.com/system/Services/Employer/{tpaId}/{employerId}

Add an employer to WCA

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.

Request body

activeFirstUse boolean

Specifies whether cards is automatically activated when a cardholder first uses the card. True-Activate on first use. False-Do not activate on first use (requires manual activation)
addressLine1 string

First line of the employer's mailing address.
addressLine2 string

Second line of the employer's mailing address, if needed.
cardExpirationMonths enum<string>

Number of months before debit cards under this employer expire.

Possible values: Months12 Months24 Months36
cardIssueAddressIndicator enum<string>

Specifies which address new cards are mailed to.

Possible values: Cardholder Employer Tpa MBI
cardReissueLeadDays enum<string>

Automatically reissue cards N days prior to expiration.

Possible values: Days15 Days30 Days45 Days60
cardOffered enum<string>

Confirms if the employer group offers the debit card.

Possible values: None FlexCard FlexCardOptional
cardSecondLine string

Preapproved card 2nd line text. If does not match existing text listed in BPS, it is not used.
checkProcessMethod enum<string>

Possible values: All UnSet None File Print
city string

City associated with the employer's address.
copayAutoReview boolean

Indicates whether the employer has employee co-pay amounts enabled.
country string

Country associated with the employer's address.
directDepositMethod enum<string>

The direct deposit method used by the employer group.

Possible values: All UnSet None File
emailAddress string

The email addresws associated with the employer.
employeeUserDefinedFields string

Name of field used by groups at the employee level. (i.e. Birthdate, Location)
employerName string

Name of the employer group.
employerPhoneNumber string

Employer group's phone number including the area code.
employerTaxId string

Tax ID number for the employer.
employerUserDefinedFields string

Name of field to be used by administrator at the group level. (i.e. Region, Tax ID Number)
employerUserDefinedFieldsData string

Data input to satisfy the field created by the Employer Defined Field. (i.e. North, 00031515)
employerFaxNumber string

Employer group's fax number with area code.
projectedEnrollees integer <int32>

Number of enrollees the employer group expects to bring to the system. This assists Alegeus Technologies with determining card inventory requirements.
recurringExpenseAutoReview boolean

Indicates whether the employer has employee recurring expense amounts enabled.
setupEmailAddress string

Email addresses separated by semicolon used to notify when group setup is completed and Employer is ready to load employees.
state string

Two letter state abbreviation associated with the group's address.
zipCode string

Zip code associated with the group's address.
thermalPrintName string

Optional, Name used to specify text that appears on the back of the cardholder’s card.
defaultCardDesign string

Possible values are Payment and Combo.
emprOptions enum<integer>

Possible values: None (0) AllowSplitAcrossPlanDesign (32) AllowExternalReimb (128) AllowIneligiblePOSOffset (256) EnableComboCard (1024) AllowParticipantEmailUpdates (2048) AllowParticipantEmailAdmin (4096) AllowParticipantAccessDependentInfo (8192) AllowParticipantRequestNewCard (16384) AllowParticipantUpdateDemoInfo (32768) AllowParticipantUpdateDirectDepositInfo (65536) AllowParticipantViewDirectDepositInfo (131072) AllowParticipantClaimsCrossOver (262144) VerifyReimbursement (524288) AllowUploadCensusRecords (1048576) AllowViewMetavanteEduContents (2097152) AllowParticipantCommunicationSelection (4194304) AllowParticipantClaimEntry (8388608) AllowParticipantReceiptUpload (16777216) AllowEmployeeDemographicSelfCreationviaOnlineEnrollment (33554431) EnableProviderPay (67108864) BillableEmployer (4294967296) DisplayClaimsoneClaimsManager (17179869184) LockEmployerStatus (34359738368)
comboCardWaitingPeriod integer <int32>
thermalLogoId string

This is the Thermal Logo (Front) description that was created in the user interface.
reimbMinAmt number <double>

This field is used to set the minimum reimbursement amount for Reimbursement Processing.
trackingNumber string
employerMarketplaceGUID string
employerAlternateID string

Alternate ID for the employer group.
copyCalendarsFromEmployer string

The Employer ID of an existing employer for which you want to copy payroll calendars from.
copyPcmTemplatesFromEmployer string

The Employer ID of an existing employer for which you want to copy participant communication templates from.
copyReimbursementScheduleFromEmployer string

The Employer ID of an existing employer for which you want to copy the reimbursement schedule from.
cardIssueAddressIndicator_2016_09 enum<string>

Possible values: Cardholder Employer Tpa MBI EmployerAlternate AdminAlternate
brandId string

Specifies which address new cards under this employer group are mailed to.
manageHSAFundingBankAccounts boolean

planLevelUserDefinedFieldLabel string

User defined field at plan level.

Min Length:	0
Max Length:	15

employeeUserDefinedField2 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField3 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField4 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField5 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField6 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField7 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField8 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField9 string

Employee user defined field.

Min Length:	0
Max Length:	15

employeeUserDefinedField10 string

Employee user defined field.

Min Length:	0
Max Length:	15

maxRealtimeReactivationPayment number <double>

When an online payment is made to fulfill a balance due, there is a standard two business day waiting period before a deactivated benefit debit card can be reactivated. If you wish, you can use this field to set a maximum online payment which will bypass the waiting period and immediately reactivate the card. Note: Leaving this field blank or setting it to '0' ensures all transactions are subject to the waiting period.

employerCustomerServicePhone string

Employer-level customer service phone number.

Min Length:	0
Max Length:	30

Response

TrackingNumber string
ErrorCode integer <int32>