Employer API | Administrative - SOAP

The Employer Service provides clients employer functionalities such as reading, adding, updating, and deleting employers’ information.

Service Web Methods
The following is a list of methods that is provided by the Employer Service.

AddEmployer - used to add an employer's demographic information.
GetEmployer - used to retrieve an employer's demographic information.
GetEmployers - used to retrieve a list of employers for a given administrator.
UpdateEmployer - used to update an employer's demographic information.
CopyReportSchedule - used to copy an employer's report schedules to another employer.

Service Assumptions/Business Rules
The Employer Service makes the following assumptions as well as enforces the following business rules.

Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the administrator.
Clients shall format SOAP messages in a Document/Literal format over HTTPS.
Clients shall have already created a valid user ID and password.
Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the Account Manager Service Guide.
If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
If any method fails, the service returns a SOAP fault describing the problem.

AddEmployer

This method is used to add an employer’s demographic information.

History
The AddEmployer methods are listed below:

Request Messages

AddEmployerRequest_2020_01
AddEmployerRequest

Response Messages

AddEmployerResponse

AddEmployer Request/Response Messages

The AddEmployer method requires the following request and response messages (input and output data).

The table below includes the following request messages:

AddEmployerRequest

Request Body

ActiveFirstUseBoolean
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)
First Available Version: AddEmployerRequest
Default Values: FALSE
AddressLine1Stringrequired
First line of the employer’s mailing address. (Cannot be a P.O. Box)
First Available Version: AddEmployerRequest
Max Length: 55
AddressLine2String
Second line of the employer’s mailing address.
First Available Version: AddEmployerRequest
Max Length: 55
CardExpirationMonthsEnumeration
Number of months before debit cards expire:
Months12
Months24
Months36
First Available Version: AddEmployerRequest
Default Values: Months12
CardIssueAddressIndicatorEnumeration
Specifies which address new cards are mailed to.
Cardholder – Issues cards to Cardholder’s address.
Employer – Issues cards to Employer’s address.
TPA – Issues cards to administrator’s address.
MBI – Issue cards to Alegeus Technologies’ address.
First Available Version: AddEmployerRequest
Default Values: Cardholder
CardReissueLeadDaysEnumeration
Automatically reissue cards N days prior to expiration.
Days15
Days30
Days45
Days60
First Available Version: AddEmployerRequest
Default Values: Days15
CardOfferedEnumeration
Confirms if the employer group offers the debit card.
None
FlexCard
FlexCardOptional
Note: If this field is not passed, the system defaults to FlexCard.
First Available Version: AddEmployerRequest
Default Values: None
CardSecondLineString
Preapproved card 2nd line text. If does not match existing text listed in BPS, it is not used.
First Available Version: AddEmployerRequest
CheckProcessMethodEnumeration
None
File
Print
First Available Version: AddEmployerRequest
Default Values: None
CityStringrequired
City associated with the employer’s address.
First Available Version: AddEmployerRequest
Max Length: 30
CopayAutoReviewBoolean
Indicates whether the employer has employee co-pay amounts enabled.
First Available Version: AddEmployerRequest
Default Values: FALSE
CountryStringrequired
Country associated with the employer's address.
First Available Version: AddEmployerRequest
Default Values: “US”
DirectDepositMethodEnumeration
The direct deposit method used by the employer group:
None
File
First Available Version: AddEmployerRequest
Default Values: None
EmailAddressString
Email address associated with the employer.
First Available Version: AddEmployerRequest
EmployeeUserDefinedFieldsString
Name of field used by groups at the employee level. (i.e. Birthdate, Location)
First Available Version: AddEmployerRequest
EmployerForTestingBoolean
Select true if this is a test employer.
First Available Version: AddEmployerRequest
Default Values: FALSE
EmployerIdStringrequired
Only 6 characters allowed on INSERT.
Excludes the three character Employer ID Prefix (as shown on Administrator Demographic screen in BPS), because it
is added automatically on INSERT.
First Available Version: AddEmployerRequest
Max Length: 18
EmployerNameStringrequired
Complete employer group name. This is the name used on reports generated by the system.
First Available Version: AddEmployerRequest
EmployerPhoneNumberString
Group’s phone number with area code.
Blanks for extension if not one. (###) ###-#### ####
First Available Version: AddEmployerRequest
EmployerTaxIdString
Tax ID number for the employer.
First Available Version: AddEmployerRequest
EmployerUserDefinedFieldsString
Name of field to be used by administrator at the group level. (i.e. Region, Tax ID Number)
First Available Version: AddEmployerRequest
EmployerUserDefinedFieldsDataString
Data input to satisfy the field created by the Employer Defined Field. (i.e. North, 00031515)
First Available Version: AddEmployerRequest
EmployerFaxNumberString
Group’s fax number with area code.
Blanks for extension if not one. (###) ###-#### ####
First Available Version: AddEmployerRequest
ProjectedEnrolleesIntegerrequired
Number of enrollees the employer group expects to bring to the system. This assists Alegeus Technologies with determining card inventory requirements.
First Available Version: AddEmployerRequest
Default Values: 0
RecurringExpenseAutoReviewBoolean
Indicates whether the employer has employee recurring expense amounts enabled.
First Available Version: AddEmployerRequest
Default Values: FALSE
SetupEmailAddressStringrequired
Email addresses separated by semicolon used to notify when group setup is completed and Employer is ready to load employees.
First Available Version: AddEmployerRequest
StateStringrequired
Two letter state abbreviation associated with the group’s address.
First Available Version: AddEmployerRequest
TpaIdStringrequired
A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
First Available Version: AddEmployerRequest
ZipCodeStringrequired
Up to nine digit Zip Code associated with the group’s address. Limited to either five (5) or nine (9) characters. Numbers only.
First Available Version: AddEmployerRequest
ThermalPrintNameString
Optional, Name used to specify text that appears on the back of the cardholder’s card.
First Available Version: AddEmployerRequest_2006_12
DefaultCardDesignString
For future use. Card design will currently always be payment.
First Available Version: AddEmployerRequest_2007_12
Default Values: Payment
EmprOptionsInt
Values are:
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 = 3355443
EnableProviderPay =67108864
ExcludeReimbursementIfTI= 1073741824
BillableEmployer =4294967296
DisplayClaimsoneClaimsManager = 17179869184
LockEmployerStatus =34359738368
First Available Version: AddEmployerRequest_2009_04
AllowParticipantstoAddDependents = 68719476736
AllowParticipantstoAddDependentAccounts =137438953472
AllowParticipantstoOrderDependentCard =274877906944
RequireDependentDOBandSSNonPortal =549755813888
AllowCardReimbursementOption = 1099511627776
EnableCardReimbursementDefault = 2199023255552
EnrollmentNotAllowed =4398046511104
Allow employer to managebank configuration for HSA funding =70368744177664
Enable Mobile Pay = 36028797018963968

Note: This is a bit field. To enable multiple options add up the values. See the bit field guide for more information.
Example: To enable AllowSplitAcrossPlanDesign and EnableComboCard the EmprOptionsshould be set to: 32 + 1024 = 1056.
Note 2: Mobile Pay must be activated for your administrator instance of WCA before you can use this option to enable for employers.
First Available Version:
ComboCardWaitingPeriodShort
This is a legacy field; this field will not currently be used.
First Available Version: AddEmployerRequest_2007_12
Default Values: 0
ThermalLogoIdString
This is the Thermal Logo (Front) description that was created in the user interface.
First Available Version: AddEmployerRequest_2007_12
ReimbMinAmtDecimal
This field is used to set the minimum reimbursement amount for Reimbursement Processing.
First Available Version: AddEmployerRequest_2009_04
Default Values: 0
TrackingNumberString
This field is returned with the response and not used by WCA.
First Available Version: AddEmployerRequest_2010_10
CopyCalendarsFromEmployerString
The Employer ID of an existing employer for which you want to copy payroll calendars from
First Available Version: AddEmployerRequest_ 015_06
CopyPCMTemplatesFromEmployerString
The Employer ID of an existing employer for which you want to copy participant communication templates from
First Available Version: AddEmployerRequest_2015_06
CopyReimbursementScheduleFromEmployerString
The Employer ID of an existing employer for which you want to copy the reimbursement schedule from.
First Available Version: AddEmployerRequest_ 015_10
CardIssueAddressIndicator-_2016_09Enumeration
Specifies which address new cards are mailed to.
Cardholder – Issues cards to Cardholder’s address.
Employer – Issues cards to Employer’s address.
TPA – Issues cards to administrator’s address.
MBI – Issue cards to Alegeus Technologies’ address.
Employer Alternate – Issue cards to employer’s alternate address.
TPA Alternate – Issue cards to administrator’s alternate address.
First Available Version: AddEmployerRequest_ 016_09
Default Values: Cardholder
BrandIdString
This field is used to associate a Brand ID to the employer group. Brand ID must first be configured on the admin > settings > branding page in WCA.
First Available Version: AddEmployerRequest_2017_02
Max Length: 20
userfieldlabelString
Use this field to create a custom field on the plan level.
WealthCare Admin does not use this field.
First Available Version: AddEmployerRequest_2018_06
Max Length: 15
EmployeeUserDefinedField2String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField3String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField4String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField5String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField6String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField7String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField8String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField9String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedField10String
Field defined by administrator. Not used by WCA.
First Available Version: AddEmployerRequest_2018_10
Max Length: 15
CustomerServicePhoneString
Employer-level customer service phone number
First Available Version: AddEmployerRequest_2019_02
Max Length: 30
MaxRealtimeReactivationPaymentDecimal
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.
First Available Version: AddEmployerRequest_2019_02
Max Length: 19
CalendarIdString
Employer's selected calendar list is assigned the calendar corresponding to the submitted calendar ID. Must exactly match the calendar ID in WCA.
If you do not wish to assign a calendar, leave blank.
First Available Version: AddEmployerRequest_2020_01
Max Length: 50
CardStockIdString
Card stock ID for the card stock to assign for this employer. Must exactly match the card stock ID in WCA.
Note: For add/update, if left blank, the default card stock is used
First Available Version: AddEmployerRequest_2020_01
Max Length: 5

Response Message: Empty Message

Example of an AddEmployer SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>k53d2c55oiux1s55aonmagis</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<AddEmployer_2006_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2006/12/">
<addEmployerRequest_2006_12>
           <ActiveFirstUse>true</ActiveFirstUse>
<AddressLine1>123 Test St</AddressLine1>
<AddressLine2>Apt 2</AddressLine2>
<BucketSplit>true</BucketSplit>
<CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder</CardIssueAddressIndicator>
<CardOffered xmlns="http://www.medibank.com/MBIWebServices/Enums/">FlexCard</CardOffered>
<CheckProcessMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">File</CheckProcessMethod>
<City>TestCity</City>
<CopayAutoReview>true</CopayAutoReview>
<Country>US</Country>
<DirectDepositMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">File</DirectDepositMethod>
<EmailAddress>test@test.com</EmailAddress>
<EmployerId>EASE7</EmployerId>
<EmployerName>EASE7</EmployerName>
<EmployerPhoneNumber>777 555 - 3333</EmployerPhoneNumber>
<EmployerTaxId>123456789</EmployerTaxId>
<EmployerFaxNumber>777 555 - 3333</EmployerFaxNumber>
<ProjectedEnrollees>1000</ProjectedEnrollees>
<RecurringExpenseAutoReview>true</RecurringExpenseAutoReview>
<SetupEmailAddress>test@test.com</SetupEmailAddress>
<State>MA</State>
<TpaId>T00209</TpaId>
<ZipCode>01234</ZipCode>
<ThermalPrintName>Test Print</ ThermalPrintName >
</addEmployerRequest_2006_12>
</AddEmployer_2006_12>
</soap:Body>
</soap:Envelope>

Example of an AddEmployer SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<AddEmployerResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
<AddEmployerResult />
</AddEmployerResponse>
</soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when adding an employer using the AddEmployer web method.


try
{
               // Create the session SOAP header in order to pass the Employer Service
               // the client’s current session id.
               mbiSessionHeader = new EmployerServiceNameSpace.MBISessionHeader();
// Create proxy object for the Employer Service
               proxy = new EmployerServiceNameSpace.EmployerService();
// Create request message for method call (input parameters)
               request = new EmployerServiceNameSpace.AddEmployerRequest_2006_12();
// Set the input parameters
               request.ActiveFirstUse = (bool) _activeFirstUse.SelectedItem;
               request.AddressLine1 = _addressLine1.Text;
               request.AddressLine2 = _addressLine2.Text;
               request.BucketSplit = (bool) _bucketSplit.SelectedItem;
               request.CardExpirationMonths =
                                                    (EmployerServiceNameSpace.CardExpirationMonthOptions)
_cardExpirationMonths.SelectedItem;
               request.CardExpirationMonthsSpecified = true;
               request.CardIssueAddressIndicator =
(EmployerServiceNameSpace.EmployerIssueAddress)
_cardIssueAddressIndicator.SelectedItem;
               request.CardOffered = (EmployerServiceNameSpace.CardsOfferedCodes)
                              _cardsOffered.SelectedItem;
               request.CardReissueLeadDays =
                              (EmployerServiceNameSpace.AutoCardReissueLeadDayOptions)
                              _cardReissueLeadDays.SelectedItem;
               request.CardReissueLeadDaysSpecified = true;
               request.CardSecondLine = _cardSecondLine.Text;
               request.CheckProcessMethod = (EmployerServiceNameSpace.CheckProcessMethodCodes)
                              _checkProcessMethod.SelectedItem;
               request.City = _city.Text;
               request.CopayAutoReview = (bool) _copayAutoReview.SelectedItem;
               request.Country = _country.Text;
               request.DirectDepositMethod = (EmployerServiceNameSpace.DirectDepositMethodCodes)
                              _directDepositMethod.SelectedItem;
               request.EmailAddress = _emailAddress.Text;
               request.EmployeeUserDefinedFields = _employeeUserDefinedField.Text;
               request.EmployerFaxNumber = _employerFaxNumber.Text;
               request.EmployerForTesting = (bool) _employerForTesting.SelectedItem;
               request.EmployerId = _employerId.Text;
               request.EmployerName = _employerName.Text;
               request.EmployerPhoneNumber = _employerPhoneNumber.Text;
               request.EmployerTaxId = _employerTaxId.Text;
               request.EmployerUserDefinedFields = _employerUserDefinedField.Text;
               request.EmployerUserDefinedFieldsData = _employerUserDefinedFieldData.Text;
               request.ProjectedEnrollees = Convert.ToInt32(_projectedEnrollees.Text);
               request.RecurringExpenseAutoReview = (bool)
                              _recurringExpenseAutoReview.SelectedItem;
               request.SetupEmailAddress = _setupEmailAddress.Text;
               request.State = _state.Text;
               request.TpaId = _tpaId.Text;
               request.ZipCode = _zipCode.Text;
               request.ThermalPrintName = ThermalPrintName.Text;
// session ID returned from login method
               mbiSessionHeader.MBISessionID = _sessionId.Text;
               proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
               response = proxy.AddEmployer(request);
               MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

GetEmployer

This method is used to retrieve an employer’s demographic information.

History
The GetEmployer methods are listed below:

Request Messages

GetEmployerRequest

Response Messages

GetEmployerResponse

GetEmployer Request/Response Messages
The GetEmployer method requires the following request and response messages (input and output data).

The table below includes the following request messages:

GetEmployerRequest_2019_02
GetEmployerRequest

Request Body

EmployerIdStringrequired
First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.
First Available Version: GetEmployerRequest
Max Length: 18
TpaIdString
A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
First Available Version: GetEmployerRequest
VerboseModeBoolean
Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
First Available Version: GetEmployerRequest
Default Values: FALSE
CustomerServicePhoneString
Employer-level customer service phone number
First Available Version: GetEmployerRequest_2019_02
Max Length: 30
MaxRealtimeReactivationPaymentDecimal
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.
First Available Version: GetEmployerRequest_2019_02
Max Length: 19

The table below includes the following request messages:

GetEmployerResponse_2020_01
GetEmployerResponse_2009_04
GetEmployerResponse_2007_12
GetEmployerResponse_2006_12
GetEmployerResponse

Response Body

ActiveFirstUseBoolean
Specifies whether cards are automatically activated when a cardholder first uses the card.
True – Activate on first use.
False – Do not activate on first use (requires manual activation)
First Available Version: GetEmployerResponse
AddressLine1String
First line of the employer’s mailing address.
First Available Version: GetEmployerResponse
AddressLine2String
Second line of the employer’s mailing address.
First Available Version: GetEmployerResponse
BucketSplitBoolean
Allow splitting a single transaction over multiple plans after the transaction meets the criteria of Auto Review, Third-Party Substantiation (TPS), or Over-the-Counter (OTC) Substantiation.
Note: As of 2007_12 this field is no longer returned.
First Available Version: GetEmployerResponse
CardExpirationMonthsEnumeration
Months12
Months24
Months36
First Available Version: GetEmployerResponse
CardIssueAddressIndicatorEnumeration
Specifies which address new cards are mailed to.
Cardholder – Issues cards to Cardholder’s address.
Employer – Issues cards to Group’s address.
Administrator – Issues cards to administrator’s address.
BPS – Issues cards to Alegeus Technologies’s address.
First Available Version: GetEmployerResponse
CardReissueLeadDaysEnumeration
Automatically reissue cards N days prior to expiration.
Days15
Days30
Days45
Days60
First Available Version: GetEmployerResponse
CardOfferedEnumeration
Confirms if the employer group offers the debit card.
None
FlexCard
FlexCardOptional
First Available Version: GetEmployerResponse
CardSecondLineString
Preapproved card 2nd line text. If does not match existing text listed in BPS, it is not used.
First Available Version: GetEmployerResponse
CheckProcessMethodEnumeration
None
File
Print
First Available Version: GetEmployerResponse
CityString
City associated with the employer’s address.
First Available Version: GetEmployerResponse
CopayAutoReviewBoolean
Indicates whether the employer has employee co-pay amounts enabled.
First Available Version: GetEmployerResponse
CountryString
The country of the employer group.
First Available Version: GetEmployerResponse
DirectDepositMethodEnumeration
If the group offers direct deposit reimbursement, ‘File’ is returned. If not, ‘None’ is returned.
None
File
First Available Version: GetEmployerResponse
EmailAddressString
Email address associated with the group.
First Available Version: GetEmployerResponse
EmployeeUserDefinedFieldsString
Name of field used by employers at the employee level. (i.e. Birthdate, Location)
First Available Version: GetEmployerResponse
EmployerForTestingBoolean
Returns true if this is a test employer.
First Available Version: GetEmployerResponse
EmployerIdString
First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.
First Available Version: GetEmployerResponse
EmployerNameString
Complete employer name. This is the name used on reports generated by the system.
First Available Version: GetEmployerResponse
Employer PhoneNumberString
Employer’s phone number with area code.
Blanks for extension if not one. (###) ###-#### ####
First Available Version: GetEmployerResponse
EmployerTaxIdString
Tax ID number for the employer.
First Available Version: GetEmployerResponse
EmployerStatusEnumeration
New
Active
TempInactive
PermInactive
First Available Version: GetEmployerResponse
EmployerUserDefinedFieldsString
Name of field to be used by administrator at the employer level. (i.e. Region, Tax ID Number)
First Available Version: GetEmployerResponse
EmployerUserDefinedFieldsDataString
Data input to satisfy the field created by the Employer Defined Field.
First Available Version: GetEmployerResponse
EmployerFaxNumberString
Employer’s fax number with area code. Blanks for extension if not one.
(###) ###-#### ####
First Available Version: GetEmployerResponse
ProjectedEnrolleesInteger
Number of enrollees the employer group expects to bring to the system.
This assists Alegeus Technologies in determining card inventory requirements.
First Available Version: GetEmployerResponse
RecurringExpenseAutoReviewBoolean
Indicates whether the employer has employee recurring expense amounts enabled.
First Available Version: GetEmployerResponse
SetupEmailAddressString
Email addresses separated by semicolon used to notify when employer setup is completed and Employer is ready to load employees.
First Available Version: GetEmployerResponse
StateString
The two letter state abbreviation associated with the employer’s address.
First Available Version: GetEmployerResponse
TpaIdString
A unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetEmployerResponse
ZipCodeString
Up to nine digit Zip Code associated with the employer’s address.
Limited to either five (5) or nine (9) characters.
Numbers only.
First Available Version: GetEmployerResponse
ThermalPrintNameString
Name used to specify text that appears on the back of the cardholder’s card.
First Available Version: GetEmployerResponse_2006_12
DefaultCardDesignString
For future use. Card design will currently always be payment.
First Available Version: GetEmployerResponse_2007_12
EmprOptionsInteger
Values are:
None = 0
AllowSplitAcrossPlanDesign = 32
AllowExternalReimb = 128
AllowParticipantEmailUpdates = 2048,
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
First Available Version: GetEmployerResponse_2007_12
AllowParticipantClaimEntry = 8388608
AllowParticipantReceiptUpload = 16777216
AllowEmployeeDemographicSelfCreationviaOnlineEnroll ment = 33554431
EnableProviderPay = 67108864
BillableEmployer = 4294967296
DisplayClaimsoneClaimsManager = 17179869184
LockEmployerStatus = 34359738368
AllowParticipantstoAddDependents = 68719476736
AllowParticipantstoAddDependentAccounts = 137438953472
AllowParticipantstoOrderDependentCard = 274877906944
RequireDependentDOBandSSNonPortal = 549755813888
AllowCardReimbursementOption = 1099511627776
EnableCardReimbursementDefault = 2199023255552
EnrollmentNotAllowed = 4398046511104
Allow employer to manage bank configuration for HSA funding? = 70368744177664
Note: This is a bit field. To enable multiple options add up the values. See the bit field guide for more information.
Example: To enable AllowSplitAcrossPlanDesign and EnableComboCard the EmprOptions should be set to: 32 + 1024 = 1056.
First Available Version:
ComboCardWaitingPeriodInteger
Legacy use. Combo cards are no longer in use.
First Available Version: GetEmployerResponse_2007_12
AllowSplitAcrossPlanDesignBoolean
Returns True or False.
First Available Version: GetEmployerResponse_2007_12
ThermalLogoIdString
This is the Thermal Logo (Front) description that was created in the user interface.
First Available Version: GetEmployerResponse_2007_12
ReimbMinAmtDecimal
This field is used to set the minimum reimbursement amount for Reimbursement Processing.
First Available Version: GetEmployerResponse_2009_04
UserFieldLabelString
Use this field to create a custom field on the plan level. WealthCare Admin does not use this field.
First Available Version: GetEmployerResponse_2018_06
EmployeeUserDefinedField2String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField3String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField4String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField5String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField6String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField7String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField8String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField9String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
EmployeeUserDefinedField10String
Field defined by administrator. Not used by WCA.
First Available Version: GetEmployerResponse_2018_10
CustomerServicePhoneString
Employer-level customer service phone number
First Available Version: GetEmployerResponse_2019_02
MaxRealtimeReactivationPaymentDecimal
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.
First Available Version: GetEmployerResponse_2019_02
CalendarIdString
Employer's selected calendar list is assigned the calendar corresponding to the submitted calendar ID. Must exactly match the calendar ID in WCA.
First Available Version: GetEmployerResponse_2020_01
BrandIdString
Returns the brand ID that is assigned to the employer.
First Available Version: GetEmployerResponse_2020_01
CardStockIdString
Card stock ID for the card stock to assign for this employer. Must exactly match the card stock ID in WCA.
First Available Version: GetEmployerResponse_2020_01

Example of a GetEmployer SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>k53d2c55oiux1s55aonmagis</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetEmployer xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
<getEmployerRequest>
<EmployerId>EASE7</EmployerId>
<TpaId>T00209</TpaId>
</getEmployerRequest>
</GetEmployer>
</soap:Body>
</soap:Envelope>

Example of a GetEmployer SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<GetEmployerResponse_2006_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/12/">
<GetEmployerResult xsi:type="GetEmployersResponse">
<ActiveFirstUse>true</ActiveFirstUse>
<AddressLine1>123 Test St</AddressLine1>
<AddressLine2>Apt 2</AddressLine2>
<BucketSplit>true</BucketSplit>
<CardExpirationMonths>36</CardExpirationMonths>
<CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder</CardIssueAddressIndicator>
<CardReissueLeadDays>30</CardReissueLeadDays>
<CardOffered xmlns="http://www.medibank.com/MBIWebServices/Enums/">FlexCard</CardOffered>
<CheckProcessMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">File</CheckProcessMethod>
<City>TestCity</City>
<CopayAutoReview>true</CopayAutoReview>
<Country>US</Country>
<DirectDepositMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">File</DirectDepositMethod>
<EmailAddress>test@test.com</EmailAddress>
<EmployeeUserDefinedFields />
<EmployerForTesting>false</EmployerForTesting>
<EmployerId>EASE7</EmployerId>
<EmployerName>EASE7</EmployerName>
<EmployerPhoneNumber>777 555 - 3333</EmployerPhoneNumber>
<EmployerTaxId>123456789</EmployerTaxId>
<EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</EmployerStatus>
<EmployerUserDefinedFields />
<EmployerUserDefinedFieldsData />
<EmployerFaxNumber>777 555 - 3333</EmployerFaxNumber>
<ProjectedEnrollees>1000</ProjectedEnrollees>
<RecurringExpenseAutoReview>true</RecurringExpenseAutoReview>
<SetupEmailAddress>test@test.com</SetupEmailAddress>
<State>MA</State>
<TpaId>T00209</TpaId>
<ZipCode>01234</ZipCode>
<ThermalPrintName>Test Print</ThermalPrintName>
</GetEmployerResult>
</GetEmployerResponse_2006_12>
</soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class to connect to the service) used when calling the GetEmployer method.

try
{
               _dataset.Tables["Employers"].Clear();
               // Create the session SOAP header in order to pass the Employer Service
               // the client’s current session id.
               mbiSessionHeader = new EmployerServiceNameSpace.MBISessionHeader();
// Create proxy object for the Employer Service
               proxy = new EmployerServiceNameSpace.EmployerService();
// Create request message for method call (input parameters)
               request = new EmployerServiceNameSpace.GetEmployerRequest();
// Set the input parameters
               request.EmployerId = _employerId.Text;
               request.TpaId = _tpaId.Text;
               request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
               // session ID returned from logon method
               mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
response = proxy.GetEmployer(request);
if(response != null)
{
_dataset.Tables["Employers"].Rows.Add(new string[]
{
response.ActiveFirstUse.ToString(),
response.AddressLine1,
response.AddressLine2,
response.BucketSplit.ToString(),
response.CardExpirationMonths.ToString(),
response.CardIssueAddressIndicator.ToString(),
response.CardReissueLeadDays.ToString(),
response.CardOffered.ToString(),
response.CardSecondLine,
response.CheckProcessMethod.ToString(),
response.City,
response.CopayAutoReview.ToString(),
response.Country,
response.DirectDepositMethod.ToString(),
response.EmailAddress,
response.EmployeeUserDefinedFields,
response.EmployerForTesting.ToString(),
response.EmployerId,
response.EmployerName,
response.EmployerPhoneNumber,
response.EmployerTaxId,
response.EmployerStatus.ToString(),
response.EmployerUserDefinedFields,
response.EmployerUserDefinedFieldsData,
response.EmployerFaxNumber,
response.ProjectedEnrollees.ToString(),
response.RecurringExpenseAutoReview.ToString(),
response.SetupEmailAddress,
response.State,
response.TpaId,
response.ZipCode,
response.ThermalPrintName
            });
      }

GetEmployers

This method is used to retrieve a list of employers for a given administrator.

History
The GetEmployers methods are listed below:

Request Messages

GetEmployersRequest

Response Messages

GetEmployersResponse

GetEmployers Request/Response Messages
The GetEmployers method requires the following request and response messages (input and output data).
The table below includes the following request messages:

GetEmployersResponse_2020_01
GetEmployersResponse_2018_10
GetEmployersResponse_2018_06
GetEmployersResponse_2009_04
GetEmployersResponse_2007_12
GetEmployersRequest

Request Body

TpaIdStringrequired
A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
First Available Version: GetEmployersRequest
VerboseModeBoolean
Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
First Available Version: GetEmployersRequest
Default Values: FALSE

The table below includes the following response messages:

GetEmployersResponse

Response Body

ActiveFirstUseBoolean
Specifies whether cards are automatically activated when a cardholder first uses the card.
True – Activate on first use
False – Do not activate on first use (requires manual activation)
First Available Version: GetEmployersResponse
BucketSplitBoolean
Allow splitting a single transaction over multiple plans after the transaction meets the criteria of Auto Review, Third-Party Substantiation (TPS), or Over-the-Counter (OTC) Substantiation.
Note: As of 2007_12 this field is no longer returned.
First Available Version: GetEmployersResponse
CityString
City associated with the employer’s address.
First Available Version: GetEmployersResponse
CopayAutoReviewBoolean
Indicates whether the employer has employee co-pay amounts enabled.
First Available Version: GetEmployersResponse
EmailAddressString
Email address associated with the employer.
First Available Version: GetEmployersResponse
EmployerIdString
First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.
First Available Version: GetEmployersResponse
EmployerNameString
Complete employer name. This is the name used on reports generated by the system.
First Available Version: GetEmployersResponse
EmployerStatusEnumeration
Status of the employer
New
Active
TempInactive
PermInactive
First Available Version: GetEmployersResponse
RecurringExpenseAutoBoolean
Indicates whether the employer has employee recurring expense amounts enabled.
First Available Version: GetEmployersResponse
StateString
The two letter state abbreviation associated with the group’s
First Available Version: GetEmployersResponse
TpaIdString
A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
First Available Version: GetEmployersResponse
DefaultCardDesignString
For future use. Card design will currently always be payment.
First Available Version: GetEmployersResponse_2007_12
EmprOptionsInteger
Values are:
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
AllowEmployeeDemographicSelfCreationviaOnlin eEnrollment = 33554431
EnableProviderPay = 67108864
BillableEmployer = 4294967296
DisplayClaimsoneClaimsManager = 17179869184
LockEmployerStatus = 34359738368
AllowParticipantstoAddDependents = 68719476736
First Available Version: GetEmployersResponse_2007_12
AllowParticipantstoAddDependentAccounts = 137438953472
AllowParticipantstoOrderDependentCard = 274877906944
RequireDependentDOBandSSNonPortal = 549755813888
AllowCardReimbursementOption = 1099511627776
EnableCardReimbursementDefault = 2199023255552
EnrollmentNotAllowed = 4398046511104
Allow employer to manage bank configuration for HSA funding? = 70368744177664
Note: This is a bit field. To enable multiple options add up the values. See the bit field guide for more information.
Example: To enable AllowSplitAcrossPlanDesign and EnableComboCard the EmprOptions should be set to: 32 + 1024 = 1056.
First Available Version:
ComboCardWaitingPeriodInteger
Legacy field. Combo cards are no longer in use.
First Available Version: GetEmployersResponse_2007_12
AllowSplitAcrossPlanDesignBoolean
Returns true or false.
First Available Version: GetEmployersResponse_2007_12
ThermalLogoIdString
This is the Thermal Logo (Front) description that was created in the user interface.
First Available Version: GetEmployersResponse_2007_12
ReimbMinAmtDecimal
This field is used to set the minimum reimbursement amount for Reimbursement Processing.
First Available Version: GetEmployersResponse_2009_04
UserFieldLabelString
Use this field to create a custom field on the plan level. WealthCare Admin does not use this field.
First Available Version: GetEmployersResponse_2018_06
EmployeeUserDefinedFieldLabel1String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel2String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel3String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel4String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel5String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel6String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel7String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel8String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel9String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
EmployeeUserDefinedFieldLabel10String
Name of custom field used at the employee level.
First Available Version: GetEmployersResponse_2018_10
CalendarIdString
Employer's selected calendar list is assigned the calendar corresponding to the submitted calendar ID. Must exactly match the calendar ID in WCA.
First Available Version: GetEmployersResponse_2020_01
BrandIdString
Returns the brand ID that is assigned to the employer.
First Available Version: GetEmployersResponse_2020_01
CardStockIdString
Card stock ID for the card stock to assign for this employer. Must exactly match the card stock ID in WCA.
First Available Version: GetEmployersResponse_2020_01

Example of a GetEmployers SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>k53d2c55oiux1s55aonmagis</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetEmployers xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
<getEmployersRequest>
<TpaId>T00209</TpaId>
</getEmployersRequest>
</GetEmployers>
</soap:Body>
</soap:Envelope>

Example of a GetEmployers SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<GetEmployersResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
<GetEmployersResult>
<GetEmployersResponse>
<ActiveFirstUse>true</ActiveFirstUse>
<BucketSplit>false</BucketSplit>
<City>Shelbyville</City>
<CopayAutoReview>false</CopayAutoReview>
<EmailAddress />
<EmployerId>EAS000001</EmployerId>
<EmployerName>Sand and Steel Corporation</EmployerName>
<EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</EmployerStatus>
<RecurringExpenseAutoReview>false</RecurringExpenseAutoReview>
<State>MA</State>
<TpaId>T00209</TpaId>
</GetEmployersResponse>
</GetEmployersResult>
</GetEmployersResponse>
</soap:Body>
</soap:Envelope>

Example Client Code
The following is an example of the client code (using a .NET proxy class to connect to the service) used when calling the GetEmployers method.

try
{
           _dataset.Tables["Employers"].Clear();
           // Create the session SOAP header in order to pass the Employer Service
           // the client’s current session id.
           mbiSessionHeader = new EmployerServiceNameSpace.MBISessionHeader();
// Create proxy object for the Employer Service
           proxy = new EmployerServiceNameSpace.EmployerService();
// Create request message for method call (input parameters)
           request = new EmployerServiceNameSpace.GetEmployerRequest();
// Set the input parameters
           request.TpaId = _tpaId.Text;
           request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
           // session ID returned from logon method
           mbiSessionHeader.MBISessionID = _sessionId.Text;
           proxy.MBISessionHeaderValue = mbiSessionHeader;
           responses = proxy.GetEmployers(request);
           if(responses != null)
           {
                      for(int i=0; i < responses.Length; i++)
                      {
                        _dataset.Tables["Employers"].Rows.Add(new string[]
                         {
                                 responses[i].ActiveFirstUse.ToString(),
                                 responses[i].AddressLine1,
                                 responses[i].AddressLine2,
                                 responses[i].BucketSplit.ToString(),
                                 responses[i].CardExpirationMonths.ToString(),
                                 responses[i].CardIssueAddressIndicator.ToString(),
                                 responses[i].CardReissueLeadDays.ToString(),
                                 responses[i].CardOffered.ToString(),
                                 responses[i].CardSecondLine,
                                 responses[i].CheckProcessMethod.ToString(),
                                 responses[i].City,
                                 responses[i].CopayAutoReview.ToString(),
                                 responses[i].Country,
                                 responses[i].DirectDepositMethod.ToString(),
                                 responses[i].EmailAddress,
                                 responses[i].EmployeeUserDefinedFields,
                                 responses[i].EmployerForTesting.ToString(),
                                 responses[i].EmployerId,
                                 responses[i].EmployerName,
                                 responses[i].EmployerPhoneNumber,
                                 responses[i].EmployerTaxId,
                                 responses[i].EmployerStatus.ToString(),
                                 responses[i].EmployerUserDefinedFields,
                                 responses[i].EmployerUserDefinedFieldsData,
                                 responses[i].EmployerFaxNumber,
                                 responses[i].ProjectedEnrollees.ToString(),
                                 responses[i].RecurringExpenseAutoReview.ToString(),
                                 responses[i].SetupEmailAddress,
                                 responses[i].State,
                                 responses[i].TpaId,
                                 responses[i].ZipCode
                       });
                }
              }
 }
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

UpdateEmployer

This method is used to update an employer’s demographic information.

History
The UpdateEmployer methods are listed below:

Request Messages

UpdateEmployerRequest_2020_01
UpdateEmployerRequest

Response Messages

UpdateEmployerResponse

UpdateEmployer Request/Response Messages
The UpdateEmployer method requires the following request and response messages (input and output data).
The table below includes the following request messages:

UpdateEmployerRequest

Request Body

ActiveFirstUseBoolean
Specifies whether cards are automatically activated when a cardholder first uses the card.

True – Activate on first use
False – Do not activate on first use (requires manual activation)
First Available Version: UpdateEmployerRequest
Default Values: FALSE
AddressLine1Stringrequired
First line of the employer’s mailing address.
First Available Version: UpdateEmployerRequest
Max Length: 55
AddressLine2String
Second line of the employer’s mailing address.
First Available Version: UpdateEmployerRequest
Max Length: 55
CardExpirationMonthsEnumeration
The number of months between issue date and expiration date of the card
Months12
Months24
Months36
First Available Version: UpdateEmployerRequest
Default Values: Months12
CardIssueAddressIndicatorEnumeration
Specifies which address new cards are mailed to
Cardholder – Issues cards to Cardholder’s address
Employer – Issues cards to Group’s address
Administrator – Issues cards to administrator’s address
BPS – Issues cards to Alegeus Technologies’ address
First Available Version: UpdateEmployerRequest
Default Values: Cardholder
CardReissueLeadDaysEnumeration
Automatically reissue cards N days prior to expiration.

Days15
Days30
Days45
Days60
First Available Version: UpdateEmployerRequest
Default Values: Days15
CardSecondLineString
Pre-approved card 2nd line text. If does not match existing text listed in BPS, it is not used.
First Available Version: UpdateEmployerRequest
CheckProcessMethodEnumeration
None
File
Print
First Available Version: UpdateEmployerRequest
Default Values: None
CityStringrequired
City associated with the employer’s address.
First Available Version: UpdateEmployerRequest
Max Length: 30
CopayAutoReviewBoolean
Indicates whether the employer has employee co-pay amounts enabled.
First Available Version: UpdateEmployerRequest
Default Values: FALSE
CountryStringrequired
Country code for the employer. Only "US" is supported at this time.
First Available Version: UpdateEmployerRequest
Default Values: “US”
DirectDepositMethodEnumeration
The direct deposit method used by the employer group:
None
File
First Available Version: UpdateEmployerRequest
Default Values: None
EmailAddressString
Email address associated with the employer.
First Available Version: UpdateEmployerRequest
EmployeeUserDefinedFieldsString
Name of field used by employers at the employee level. (i.e. Birthdate, Location)
First Available Version: UpdateEmployerRequest
EmployerIdStringrequired
Only 6 characters allowed on INSERT. Exclude three character Employer ID Prefix (as shown on Administrator Demographic screen in BPS), because it is added automatically on INSERT.
First Available Version: UpdateEmployerRequest
Max Length: 18
EmployerNameStringrequired
Complete employer name. This is the name used on reports generated by the system.
First Available Version: UpdateEmployerRequest
EmployerPhoneNumberString
Employer’s phone number with area code.
Blanks for extension if one does not exist (###) ###-#### ####
First Available Version: UpdateEmployerRequest
EmployerStatusEnumeration
Status of the employer
New
Active
TempInactive
PermInactive

Note: If the employer is Active, than this field needs to be included in the request.
First Available Version: UpdateEmployerRequest
Default Values: New
EmployerTaxIdString
Tax ID number for the employer.
First Available Version: UpdateEmployerRequest
EmployerUserDefinedFieldsString
Name of field to be used by administrator at the employer level. (i.e. Region, Tax ID Number)
First Available Version: UpdateEmployerRequest
EmployerUserDefinedFieldsDataString
Data input to satisfy the field created by the Employer Defined Field. (i.e. North, 00031515)
First Available Version: UpdateEmployerRequest
EmployerFaxNumberString
Employer’s fax number with area code. Blanks for extension if one does not exist. (###) ###-#### ####
First Available Version: UpdateEmployerRequest
ProjectedEnrolleesIntegerrequired
Number of enrollees the employer group expects to bring to the system. This assists Alegeus Technologies with determining card inventory requirements.
First Available Version: UpdateEmployerRequest
RecurringExpenseAutoReviewBoolean
Indicates whether the employer has employee recurring expense amounts enabled.
First Available Version: UpdateEmployerRequest
Default Values: FALSE
SetupEmailAddressStringrequired
Email addresses separated by semicolon used to notify when employer setup is completed and Employer is ready to load employees.
First Available Version: UpdateEmployerRequest
StateStringrequired
Two letter state abbreviation associated with the employer’s address.
First Available Version: UpdateEmployerRequest
TpaIdstringrequired
A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
First Available Version: UpdateEmployerRequest
ZipCodeStringrequired
Up to nine digit Zip Code associated with the employer’s address. Limited to either five (5) or nine (9) characters. Numbers only.
First Available Version: UpdateEmployerRequest
ThermalPrintNameString
Name used to specify text that appears on the back of the cardholder’s card.
First Available Version: UpdateEmployerRequest_2006_12
DefaultCardDesignString
"Payment" is currently the only valid option.
First Available Version: UpdateEmployerRequest_ 2007_12
Default Values: Payment
EmprOptionsInt
Values are:

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
First Available Version: UpdateEmployerRequest_ 2008_07
AllowParticipantstoAddDependents = 68719476736
AllowParticipantstoAddDependentAccounts = 137438953472
AllowParticipantstoOrderDependentCard = 274877906944
RequireDependentDOBandSSNonPortal = 549755813888
AllowCardReimbursementOption = 1099511627776
EnableCardReimbursementDefault = 2199023255552
EnrollmentNotAllowed =4398046511104
AllowEmployerToManageBankConfigurationForHSAFunding = 70368744177664
EnableMobilePay = 36028797018963968

Note: This is a bit field.To enable multiple options add up the values. See bit field guide for more information.
Example: To enable AllowSplitAcrossPlanDesign and EnableComboCard the EmprOptions should be set to: 32+024= 1056. See Bit Field Guide for more details.
Note 2: Mobile Pay must be activated for your administrator instance of WCA before you can use this option to enable for employers.
Note 3: If the employer is assigned to any employer self-service template and this field is used to attempt to update self-service options, an error displays.
First Available Version:
ComboCardWaitingPeriodShort
Legacy field. Combo cards are no longer in use.
First Available Version: UpdateEmployerRequest_2007_12
Default Values: 30
ThermalLogoIdString
This is the Thermal Logo (Front) description that was created in the user interface.
First Available Version: UpdateEmployerRequest_2007_12
ReimbMinAmtDecimal
This field is used to set the minimum reimbursement amount for Reimbursement Processing.
First Available Version: UpdateEmployerRequest_ 2009_04
CardOfferedEnumeration
Confirms if the employer group offers the debit card.
None
FlexCard
FlexCardOptional
Note: If this field is not passed, the system defaults to FlexCard.
First Available Version: UpdateEmployerRequest_ 2009_04
Default Values: None
TrackingNumberString
This field is returned with the response.
First Available Version: UpdateEmployerRequest_2010_10
CopyCalendarsFromEmployerString
The Employer ID of an existing employer for which you want to copy payroll calendars from
First Available Version: UpdateEmployerRequest_2015_06
CopyPCMTemplatesFromEmployerString
The Employer ID of an existing employer for which you want to copy participant communication templates from
First Available Version: UpdateEmployerRequest_2015_06
CopyReimbursementScheduleFromEmployerString
The Employer ID of an existing employer for which you want to copy the reimbursement schedule from.
First Available Version: UpdateEmployerRequest_2015_10
CardIssueAddressIndicator_2016_09Enumeration
Specifies which address new cards are mailed to.
Cardholder – Issues cards to Cardholder’s address.
Employer – Issues cards to Employer’s address.
TPA – Issues cards to administrator’s address.
Technologies’ address.
Employer Alternate – Issue cards to employer’s alternate address.
TPA Alternate – Issue cards to administrator’s alternate address.
First Available Version: UpdateEmployerRequest_2016_09
Default Values: Cardholder
BrandIdString
This field is used to associate a Brand ID to the employer group. Brand ID must first be configured on the admin > settings > branding page in WCA.
First Available Version: UpdateEmployerRequest_2017_02
Max Length: 20
userfieldlabelString
Use this field to create a custom field on the plan level.
WealthCare Admin does not use this field.
First Available Version: UpdateEmployerRequest_2018_06
Max Length: 15
EmployeeUserDefinedLabel1String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel2String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel3String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel4String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel5String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel6String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel7String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel8String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel9String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
EmployeeUserDefinedLabel10String
Name of custom field used at the employee level.
First Available Version: UpdateEmployerRequest_2018_10
Max Length: 15
CustomerServicePhoneString
Employer-level customer service phone number
First Available Version: UpdateEmployerRequest_2019_02
Max Length: 30
MaxRealtimeReactivationPaymentDecimal
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.
First Available Version: UpdateEmployerRequest_2019_02
Max Length: 19
CalendarIdString
Employer's selected calendar list is assigned the calendar corresponding to the submitted calendar ID. Must exactly match the calendar ID in WCA.
If you do not wish to assign a calendar, leave blank.
First Available Version: UpdateEmployerRequest_2020_01
Max Length: 50
CardStockIdString
Card stock ID for the card stock to assign for this employer. Must exactly match the card stock ID in WCA.

Note: For add/update, if left blank, the default card stock is used
First Available Version: UpdateEmployerRequest_2020_01
Max Length: 5

Response Message: Empty Message

Example of a UpdateEmployer SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>k53d2c55oiux1s55aonmagis</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<UpdateEmployer_2006_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2006/12/">
<updateEmployerRequest_2006_12>
<ActiveFirstUse>true</ActiveFirstUse>
<AddressLine1>567 Test St</AddressLine1>
<AddressLine2>Apt 2</AddressLine2>
<BucketSplit>true</BucketSplit>
<CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder</CardIssueAddressIndicator>
<CheckProcessMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">File</CheckProcessMethod>
<City>TestCityUSA</City>
<CopayAutoReview>true</CopayAutoReview>
<Country>US</Country>
<DirectDepositMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</DirectDepositMethod>
<EmailAddress>test@test.com</EmailAddress>
<EmployerId>EASE7</EmployerId>
<EmployerName>EASE7</EmployerName>
<EmployerPhoneNumber>555 555 - 5555</EmployerPhoneNumber>
<EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</EmployerStatus>
<EmployerTaxId>12222222</EmployerTaxId>
<EmployerFaxNumber>555 555 - 5555</EmployerFaxNumber>
<ProjectedEnrollees>22</ProjectedEnrollees>
<SetupEmailAddress>test@test.com</SetupEmailAddress>
<State>MA</State>
<TpaId>T00209</TpaId>
<ZipCode>11111</ZipCode>
<ThermalPrintName>TextToInclude</ThermalPrintName>
</updateEmployerRequest_2006_12>
</UpdateEmployer_2006_12>
</soap:Body>
</soap:Envelope>

Example of a UpdateEmployer SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<UpdateEmployerResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
<UpdateEmployerResult />
</UpdateEmployerResponse>
</soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class for the service) used when calling the UpdateEmployer method.

try
{
           // Create the session SOAP header in order to pass the Employer Service
           // the client’s current session id.
           mbiSessionHeader = new EmployerServiceNameSpace.MBISessionHeader();
// Create proxy object for the Employer Service
           proxy = new EmployerServiceNameSpace.EmployerService();
// Create request message for method call (input parameters)
           request = new EmployerServiceNameSpace.UpdateEmployerRequest_2006_12();
// Set the input parameters
           request.ActiveFirstUse = (bool) _activeFirstUse.SelectedItem;
           request.AddressLine1 = _addressLine1.Text;
           request.AddressLine2 = _addressLine2.Text;
           request.BucketSplit = (bool) _bucketSplit.SelectedItem;
           request.CardExpirationMonths =
                                 (EmployerServiceNameSpace.CardExpirationMonthOptions)
_cardExpirationMonths.SelectedItem;
           request.CardExpirationMonthsSpecified = true;
           request.CardIssueAddressIndicator =
                                 (EmployerServiceNameSpace.EmployerIssueAddress)
_cardIssueAddressIndicator.SelectedItem;
           request.CardReissueLeadDays =
                      (EmployerServiceNameSpace.AutoCardReissueLeadDayOptions)
                      _cardReissueLeadDays.SelectedItem;
          request.CardReissueLeadDaysSpecified = true;
          request.CardSecondLine = _cardSecondLine.Text;
          request.CheckProcessMethod = (EmployerServiceNameSpace.CheckProcessMethodCodes)
                    _checkProcessMethod.SelectedItem;
          request.City = _city.Text;
          request.CopayAutoReview = (bool) _copayAutoReview.SelectedItem;
          request.Country = _country.Text;
          request.DirectDepositMethod = (EmployerServiceNameSpace.DirectDepositMethodCodes)
                    _directDepositMethod.SelectedItem;
          request.EmailAddress = _emailAddress.Text;
          request.EmployeeUserDefinedFields = _employeeUserDefinedField.Text;
          request.EmployerFaxNumber = _employerFaxNumber.Text;
          request.EmployerStatus = (EmployerServiceNameSpace.EmployerStatusCodes)
                    _employerStatus.SelectedItem;
          request.EmployerId = _employerId.Text;
          request.EmployerName = _employerName.Text;
          request.EmployerPhoneNumber = _employerPhoneNumber.Text;
          request.EmployerTaxId = _employerTaxId.Text;
          request.EmployerUserDefinedFields = _employerUserDefinedField.Text;
          request.EmployerUserDefinedFieldsData = _employerUserDefinedFieldData.Text;
          request.ProjectedEnrollees = Convert.ToInt32(_projectedEnrollees.Text);
          request.RecurringExpenseAutoReview = (bool)
_recurringExpenseAutoReview.SelectedItem;
          request.SetupEmailAddress = _setupEmailAddress.Text;
          request.State = _state.Text;
          request.TpaId = _tpaId.Text;
          request.ZipCode = _zipCode.Text;
// session ID returned from login method
          mbiSessionHeader.MBISessionID = _sessionId.Text;
          proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
          response = proxy.UpdateEmployer(request);
          MessageBox.Show("Finished.");
}

CopyReportSchedules

This method is used to copy an employer’s report schedules to another employer.

History
The CopyReportSchedules methods are listed below:

Request Messages

CopyReportSchedulesRequest

Response Messages

CopyReportSchedulesResponse

CopyReportSchedules Request/Response Messages
The CopyReportSchedules method requires the following request and response messages (input and output data).
The table below includes the following request messages:

CopyReportSchedules

Request Body

TpaIdStringrequired
A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: Null
OriginEmployerIDStringrequired
Employer ID for the employer where the report schedule currently exists.
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: Null
DestinationEmployerIDStringrequired
Employer ID for the employer where the new report schedule will be created.
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: Null
ScheduleNameStringrequired
Name of the report schedule that exists for the Origin Employer which will be copied to the Destination Employer
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: Null
ReportDeliveryOptionInteger
Delivery Method for the report
0 = UI Download (Default)
1 = UI Download, Email
2 = UI Download, FTP
3 = UI Download, Email, FTP
4 = Adminisource
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: 0
EmailOfRecipientString
Recipient’s email address.

Note: If ReportDeliveryOption 1 or 3 is selected, this field is required and must contain a valid email address. Otherwise, this field is ignored.
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: Null
EmailOfSenderString
Sender’s email address.
Note: If ReportDeliveryOption 1 or 3 is selected, this field is required and must contain a valid email address. Otherwise, this field is ignored.
First Available Version: CopyReportSchedulesRequest_2016_02
Default Values: Null

Response Message: Empty Message

Example of a CopyReportSchedulesRequest SOAP request message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://bensoft.metavante.com/WebServices/Contracts/Employer/2009/10/V1/IEmployerService/CopyReportSchedule</Action>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">pgza1bg4eycmfsw0aunmog4h</MBISessionID>
</mbiSessionHeader>
</s:Header>
<s:Body>
<CopyReportSchedule xmlns="http://bensoft.metavante.com/WebServices/Contracts/Employer/2009/10/V1">
<request xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Employer/Request/2016/02/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<d4p1:DeliveryOption>UIDownloadEmail</d4p1:DeliveryOption>
<d4p1:DestinationEmployerId>CCICOOK</d4p1:DestinationEmployerId>
<d4p1:EmailOfRecipient>reports@benefits.com</d4p1:EmailOfRecipient>
<d4p1:EmailOfSender>reports@benefits.com</d4p1:EmailOfSender>
<d4p1:OriginEmployerId>CCI0987</d4p1:OriginEmployerId>
<d4p1:ScheduleName>Weekly EAB</d4p1:ScheduleName>
<d4p1:TpaId>T02340</d4p1:TpaId>
</request>
</CopyReportSchedule>
</s:Body>
</s:Envelope>

Example of a CopyReportSchedulesRequest SOAP response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
<MessageId>urn:uuid:3380413c-b5e9-4dc5-806e-f5d35e35d412</MessageId>
</MBIMessageIdHeader>
</s:Header>
<s:Body>
<CopyReportScheduleResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/Employer/2009/10/V1">
<CopyReportScheduleResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Employer/Response/2016/02/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:ErrorCode>0</a:ErrorCode>
<a:ErrorDescription>Request submitted successfully.</a:ErrorDescription>
</CopyReportScheduleResult>
</CopyReportScheduleResponse>
</s:Body>
</s:Envelope>

First Available Version:	AddEmployerRequest
Default Values:	`FALSE`

First Available Version:	AddEmployerRequest_2007_12
Default Values:	`Payment`

First Available Version:	AddEmployerRequest_2009_04
Default Values:	`0`

First Available Version:	AddEmployerRequest_ 016_09
Default Values:	`Cardholder`

First Available Version:	AddEmployerRequest_2017_02
Max Length:	`20`

First Available Version:	AddEmployerRequest_2018_06
Max Length:	`15`

First Available Version:	AddEmployerRequest_2018_10
Max Length:	`15`

First Available Version:	AddEmployerRequest_2019_02
Max Length:	`30`

First Available Version:	UpdateEmployerRequest_ 2007_12
Default Values:	`Payment`

First Available Version:	UpdateEmployerRequest_2007_12
Default Values:	`30`

First Available Version:	UpdateEmployerRequest_ 2009_04
Default Values:	`None`

First Available Version:	UpdateEmployerRequest_2016_09
Default Values:	`Cardholder`

First Available Version:	UpdateEmployerRequest_2017_02
Max Length:	`20`

First Available Version:	UpdateEmployerRequest_2018_06
Max Length:	`15`

First Available Version:	UpdateEmployerRequest_2018_10
Max Length:	`15`

First Available Version:	UpdateEmployerRequest_2019_02
Max Length:	`30`

First Available Version:	CopyReportSchedulesRequest_2016_02
Default Values:	`Null`