Employer Logical Bank Account API | Administrative - SOAP

The Employer Logical Bank Account Service provides clients with functionalities such as reading, adding, updating, and deleting employers’ logical account information

Service Web Methods

The following is a list of methods that is provided by the Employer Logical Bank Account Service.

AddEmployerLogicalBankAccount - used to add an employer’s logical bank account information.
DeleteEmployerLogicalBankAccount - used to remove information about an employer's logical bank account.
EmployerDeposit - deposits money into the employer’s logical bank account.
GetEmployerLogicalBankAccount - used to retrieve an employer’s logical bank account information.
GetEmployerLogicalBankAccounts - used to retrieve a list of employers’ logical bank accounts.
UpdateEmployerLogicalBankAccount - used to update an employer’s logical bank account information. The account must already exist.

Service Assumptions/Business Rules

The Employer Service makes the following assumptions as well as enforce 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.

AddEmployerLogicalBankAccount

This method is used to add an employer’s logical bank account information to the system.

History

Request Message

The AddEmployerLogicalBankAccount methods are listed below:

Request Message

AddEmployerLogicalBankAccountRequest_2022_10
AddEmployerLogicalBankAccountRequest_2020_02
AddEmployerLogicalBankAccountRequest_2018_10
AddEmployerLogicalBankAccountRequest_2015_10
AddEmployerLogicalBankAccountRequest_2010_10

Request Message

AddEmployerLogicalBankAccountResponse

AddEmployerLogicalBankAccount Request/Response Messages

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

The table below includes the following request message:

AddEmployerLogicalBankAccountRequest_2022_10
AddEmployerLogicalBankAccountRequest_2020_02
AddEmployerLogicalBankAccountRequest_2018_10
AddEmployerLogicalBankAccountRequest_2015_10
AddEmployerLogicalBankAccountRequest_2010_10
AddEmployerLogicalBankAccountRequest

Request Body

BankAccountDisplayName String required

Name associated with the logical bank account.
Must be unique within the administrator
Suggested format: Group ID prefix + Group ID + 3 digit sequence number starting with 001. For example,
PFXGROUPID001.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`50`

ConvenienceFeesPaid Boolean

Indicates if convenience fees are being paid on this employer account.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

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.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`18`

MinBalanceReceiveAlert Decimal

The dollar amount that, if the account balance goes below, will result in a balance alert.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`10000`
Max Length:

NextCheckNumber Integer conditionally required

Check number for reimbursement processing. Required if UseEmployerAccountCheckNumber is set to True.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

PhysicalBankAccountName String required

Name of the ACH account to which the employer group is associated.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

ReceiveAccountAcitivityviaEmailAddress String

Email address of person selected to receive activity emails.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

ReceiveAccountAcitivityviaEmail Boolean

Indicates if daily account activity will be received via email.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

TypeOfClaimsAffected Enumer

What type of claims should affect this account?
POS
Manual
All

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`All`
Max Length:

PlanType String

Type of benefit plan or account, such as FSA, DCA, or TRN.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

UseEmployerAccountCheckNumber Boolean

Indicates if Employer Account specified check number will be used for reimbursement processing.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

ZeroBalanceAccount Boolean required

Indicates if this is a zero balance account. If true, POS claims are NOT authorized against the account.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`TRUE`
Max Length:

EnableEmployerFunding Boolean

Indicates if employer funding is enabled on this logical account.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

FundingNotificatoinToAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingNotificationCCAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via CC.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingNotificationBCCAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via BCC.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingNotificationSubject String

This field defines the subject of the email sent to employer groups communicating debits and credits to the employer funding account.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingTemplateName String

This field should be used to name the Funding Template for employer funding.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingBankAcctName String

This field should be used to name the Employer Funding Account used for employer funding.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

PhysicalBankAccountNameDD String

This is name of the physical bank account used for Direct Deposit processing.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

TrackingNumber String

The tracking number is used to identify request. If this field is sent with a request, WCA will return this value in the response.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:

ProcessLogicalDeposits Boolean

Determines whether to process logical deposits upon completion of a Claims Based funding schedule. Requires a Claim Activity Funding Template be assigned to the Logical Account.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

BeginningDate String

The begin date field is used by administrators to indicate when payroll deposits should start funding HSA accounts using the automated HSA funded functionality in WCA. Deposits inserted prior to the begin date will not be used as funding deposits.

First Available Version:	AddEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

CheckFileExportTemplate String

This is the name of template used for Check File Export.

First Available Version:	AddEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

CheckPrintingTemplate String

This is the name of template used for Check Printing.

First Available Version:	AddEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

DirectDepositFileExportTemplate String

This is the name of template used for Direct Deposit File Export.

First Available Version:	AddEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

EmployerFunding Enum

This field is required if ‘EnableEmployerFunding’ is set to True. Values:
None
Claim Activity Funding (default)
On-Demand
HSA Payroll Funding
Payroll Funding

First Available Version:	AddEmployerLogicalBankAccountRequest_2010_10
Default Values:	`ClaimActivityFunding`
Max Length:

HSAFundingOption Enum

This field is required if ‘EmployerFunding’ is set to HSA Payroll Funding. Values:
Automated Settlement
Nacha Files

First Available Version:	AddEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

ReimbursementComment String

Reimbursement comment text.

First Available Version:	AddEmployerLogicalBankAccountRequest_2015_10
Default Values:
Max Length:

ReimbursementSignature String

Reimbursement signature.

First Available Version:	AddEmployerLogicalBankAccountRequest_2015_10
Default Values:
Max Length:

DivisionName String

Default/blank = All By specifying a division, WCA limits which transactions to associate with the notional account. Must be a valid division associated with the employer.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`50`

BillingGroup String

Default/blank = All
By specifying a billing group name, WCA limits which transactions to associate with the notional account. Must be a valid billing group associated with the employer.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`150`

AccountSegmentID String

Default/blank = All
By specifying an account segment ID, WCA limits which transactions to associate with the notional account. Must be a valid account segment ID associated with the employer.
If a billing group is specified, then the account segment ID must match an account segment within the billing group.

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`15`

EnableEmployerHSAFundingManagement Boolean

This option enables the employer-level HSA funding account, on the employer level. Values: 0 – Disabled (default) 1 – Enabled

First Available Version:	AddEmployerLogicalBankAccountRequest
Default Values:	`0`
Max Length:	`1`

ProcessLogicalDeposits Enumeration

1. – Never (default)
2. – Upon completion of funding schedule
3. – Upon funding clear date
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (never) if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (never).
If field is not included in the import, existing settings remain unchanged.

First Available Version:	AddEmployerLogicalBankAccount Request_2018_10
Default Values:	`0`
Max Length:	`1`

Enable invoicing options Boolean

New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included. Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
If admin-level invoicing option is not enabled, an error is returned.
If a communication template is not enabled, an error is returned.
Note: If ‘process logical deposits upon fund clear date’ is selected, this option is defaulted to 1 (yes).

First Available Version:	AddEmployerLogicalBankAccount Request_2018_10
Default Values:	`0`
Max Length:	`1`

SuppressNacha Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included. Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import,existing settings remain unchanged.
‘Enable invoicing options’ must be set to ‘yes’ to enable this setting. If not, an error is returned.

First Available Version:	AddEmployerLogicalBankAccount Request_2018_10
Default Values:	`0`
Max Length:	`1`

Funding cleared alert Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included. Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ and ‘suppress NACHA’ both must be set to ‘yes’ to enable this setting. If not, errors are returned.

First Available Version:	AddEmployerLogicalBankAccount Request_2018_10
Default Values:	`0`
Max Length:	`1`

Track due date Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included. Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ must be set to ‘yes’ to enable this setting. If not, an error is returned.

First Available Version:	AddEmployerLogicalBankAccount Request_2018_10
Default Values:	`0`
Max Length:	`1`

Invoice due date String

Specify number of days; 1 (default) through 5
New account:
If field is included in the import, account is set to the value entered.
Defaults to 1 if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 1.
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ and ‘track due date’ both must be set to ‘yes’ to enable this.

First Available Version:	AddEmployerLogicalBankAccount Request_2018_10
Default Values:	`1`
Max Length:	`1`

Reimbursement ScheduleOverrid e1 String

Optionally include the name of existing reimbursement schedule in WCA.
WCA overrides any current/future reimbursement schedules assigned at the employer level and uses the schedule that is set using this field for all transactions affecting this notional account.

First Available Version:	AddEmployerLogicalBankAccount Request_2020_02
Default Values:
Max Length:	`50`

Reimbursement ScheduleOverrid e2 String

Optionally include the name of existing reimbursement schedule in WCA.
WCA overrides any current/future reimbursement schedules assigned at the employer level and uses schedule that is set using this field for the specified plan.
Note: Override 2 can only be set if override 1 is also set, and no division, billing group or account segment has been selected for this notional account.

First Available Version:	AddEmployerLogicalBankAccount Request_2020_02
Default Values:
Max Length:	`50`

FundingType (push/pull) Short

0 – Administrator initiated transfer method or ‘pull’ (default)
1 – Employer initiated transfer method or ‘push’
This field defaults to ‘pull’ for non-HSA funding methods if not included. For HSA funding this field is not required and is automatically set by the system.

First Available Version:	AddEmployerLogicalBankAccountRequest_2022_10
Default Values:
Max Length:	`1`

FundingAccountName String conditionally required

Required for new real time funding notional accounts only. This field is ignored unless you pass '1' for real-time in the field below.

First Available Version:	AddEmployerLogicalBankAccountRequest_2022_10
Default Values:
Max Length:	`50`

IsRealTimeFunding Short conditionally required

0 – Automated (default)
1 – Real time
This field is optional and defaults to ‘0’ (automated funding) if the field is excluded from the template and an HSA funding method is selected. If included, it becomes required.

First Available Version:	AddEmployerLogicalBankAccountRequest_2022_10
Default Values:
Max Length:	`1`

CreditEmployerAccountBalance Short

0 – Never (default)
1 – Upon completion of funding schedule
2 – Upon funding clear date
For new accounts:
If the field is included, the account is set to the value entered. Defaults to ‘0’ (never) if no value is entered or if the field is not included.
For updating existing accounts:
If field is included, the account is set to the value entered. If the field is included but no value is entered, account is set to 0 (never). If the field is not included in the import, existing settings remain unchanged.
Note: This field replaces 'process logical deposits'. ‘Process logical deposits’ may still appear on this service for now, but please use this field in its place.

First Available Version:	AddEmployerLogicalBankAccountRequest_2022_10
Default Values:
Max Length:	`1`

Response Message: Empty Message Example of an AddEmployerLogicalBankAccount 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>q0vubo55vh3met45btb0se55</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <AddEmployerLogicalBankAccount xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Request/2004/06/">
            <addEmployerLogicalBankAccountRequest>
                <BankAccountDisplayName>Test Bank Account</BankAccountDisplayName>
                <ConvenienceFeesPaid>true</ConvenienceFeesPaid>
                <EmployerId>EASEEWEWE</EmployerId>
                <MinBalanceReceiveAlert>5000</MinBalanceReceiveAlert>
                <NextCheckNumber>1000</NextCheckNumber>
                <PhysicalBankAccountName>EASBankACC1</PhysicalBankAccountName>
                <ReceiveAccountActivityViaEmailAddress>[email protected]</ReceiveAccountActivityViaEmailAddress>
                <ReceiveAccountActivityViaEmail>true</ReceiveAccountActivityViaEmail>
                <TpaId>T00209</TpaId>
                <TypeOfClaimsAffected xmlns="http://www.medibank.com/MBIWebServices/Enums/">Manual</TypeOfClaimsAffected>
                <UseEmployerAccountCheckNumber xmlns="http://www.medibank.com/MBIWebServices/Enums/">UseEmployerAccountCheckNumber
            </UseEmployerAccountCheckNumber>
        </addEmployerLogicalBankAccountRequest>
    </AddEmployerLogicalBankAccount>
</soap:Body>
</soap:Envelope>

Example of an AddEmployerLogicalBankAccount 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>
        <AddEmployerLogicalBankAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/"> <AddEmployerLogicalBankAccountResult />
    </AddEmployerLogicalBankAccountResponse>
</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 calling the AddEmployerLogicalBankAccount method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.  mbiSessionHeader =
    new EmployerLogicalBankAccountServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Employer Logical Bank Account service proxy = new
    EmployerLogicalBankAccountServiceNameSpace.EmployerLogicalBankAccountService();
    // Create request message for method call (input parameters)
    request = new
        EmployerLogicalBankAccountServiceNameSpace.AddEmployerLogicalBankAccountRequest();
    // Set the input parameters
    request.BankAccountDisplayName = _bankAccountDisplayName.Text;
    request.ConvenienceFeesPaid = (bool) _convenienceFeesPaid.SelectedItem;
    request.EmployerId = _employerId.Text;
    if(_minBalanceReceievAlert.Text.Length > 0)
    {
        request.MinBalanceReceiveAlert =
            Convert.ToDecimal(_minBalanceReceievAlert.Text);
    }
    if(_nextCheckNumber.Text.Length > 0)
    {
        request.NextCheckNumber = Convert.ToInt32(_nextCheckNumber.Text);
        request.NextCheckNumberSpecified = true;
    }
    request.PhysicalBankAccountName = _physicalBankAccountName.Text;
    request.ReceiveAccountActivityViaEmail =
        (bool) _receiveAccountActivityViaEmail.SelectedItem;
    request.ReceiveAccountActivityViaEmailAddress =
        _receiveAccountActivityEmailAddress.Text;   request.TpaId = _tpaId.Text;   request.TypeOfClaimsAffected =
        (EmployerLogicalBankAccountServiceNameSpace.BankAccountUsage) _typeOfClaimsAffected.SelectedItem;
    request.UseEmployerAccountCheckNumber =
        (EmployerLogicalBankAccountServiceNameSpace.EmployerAccountOptions)
        _useEmployerAccountCheckNumber.SelectedItem;
    request.ZeroBalanceAccount = (bool) _zeroBalanceAccount.SelectedItem;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.AddEmployerLogicalBankAccount(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

DeleteEmployerLogicalBankAccount

This method is used to remove information about an employer’s logical bank account from the system.

History

The DeleteEmployerLogicalBankAccount methods are listed below:

Request Message

DeleteEmployerLogicalBankAccountRequest

Response Message

DeleteEmployerLogicalBankAccountResponse

DeleteEmployerLogicalBankAccount Request/Response Messages

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

The table below includes the following request message:

DeleteEmployerLogicalBankAccountRequest

Request Body

BankAccountDisplayName String required

Display name associated with the logical bank account.

First Available Version:	DeleteEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`50`

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.

First Available Version:	DeleteEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`18`

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version:	DeleteEmployerLogicalBankAccountRequest
Default Values:
Max Length:

Response Message: Empty Message Example of a DeleteEmployerLogicalBankAccount 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>tzrzna45np5a1t55refepx3c</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <DeleteEmployerLogicalBankAccount xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Request/2004/06/">
            <deleteEmployerLogicalBankAccountRequest>
                <BankAccountDisplayName>Test Bank Account</BankAccountDisplayName>
                <EmployerId>EASEEWEWE</EmployerId>
                <TpaId>T00209</TpaId>
            </deleteEmployerLogicalBankAccountRequest>
        </DeleteEmployerLogicalBankAccount>
    </soap:Body>
</soap:Envelope>
Example of a DeleteEmployerLogicalBankAccount 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/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <DeleteEmployerLogicalBankAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/"> <DeleteEmployerLogicalBankAccountResult />
    </DeleteEmployerLogicalBankAccountResponse>
</soap:Body>
</soap:Envelope>

Example of a DeleteEmployerLogicalBankAccount 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>
            <DeleteEmployerLogicalBankAccountResponse
                xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/ Response/2004/06/">
                <DeleteEmployerLogicalBankAccountResult />
            </DeleteEmployerLogicalBankAccountResponse>
        </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 deleting an employer logical bank account using the DeleteEmployerLogicalBankAccount web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.  mbiSessionHeader = new
    EmployerLogicalBankAccountServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new
        EmployerLogicalBankAccountServiceNameSpace.EmployerLogicalBankAccountService();
    // Create request message for method call (input parameters)
    request = new
        EmployerLogicalBankAccountServiceNameSpace.DeleteEmployerLogicalBankAccountRequest();
    // Set the input parameters
    request.EmployerId = _employerId.Text;
    request.TpaId = _tpaId.Text;
    request.BankAccountDisplayName = _bankAccountDisplayName.Text;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.DeleteEmployerLogicalBankAccount(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

EmployerDeposit

This method deposits money into the employer’s logical bank account.

History

The EmployerDeposit methods are listed below:

Request Message

EmployerDepositRequest
EmployerDepositRequest_2018_10

Response Message

EmployerDepositResponse

EmployerDeposit Request/Response Messages

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

The table below includes the following request message:

EmployerDepositRequest

Request Body

BankAccount DisplayName String required

Display name associated with the logical bank account.

First Available Version:	EmployerDepositRequest
Default Values:
Max Length:	`50`

DepositAmount Decimal required

Deposit amount, can be negative.

First Available Version:	EmployerDepositRequest
Default Values:
Max Length:

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.

First Available Version:	EmployerDepositRequest
Default Values:
Max Length:	`18`

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version:	EmployerDepositRequest
Max Length:

CheckNumber Int32

Use this field to enter a check numbers associated with the deposit.

First Available Version:	EmployerDepositRequest
Default Values:
Max Length:

DepositTypeCode Enum

This field is used to define the type of deposit being made.
ACH
Check
Other

First Available Version:	EmployerDepositRequest
Default Values:
Max Length:

Notes String

Optional, use to include deposit notes.

First Available Version:	EmployerDepositRequest
Default Values:	`Blank`
Max Length:

TransactionDate Date

Date of the transaction. Anytime a transaction date is entered, WCA assumes you are attempting to update an existing transaction. This should be left blank for new transactions.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`8`

AccountTypeCode Alphanu meric

Used to specify the account type when updating the benefit plan associated with the deposit. Example: FSA, DCA, etc.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`10`

PlanID Alphanu meric

Used to specify the plan ID when updating the benefit plan associated with the deposit.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`18`

PlanStartDate Date

(YYYMMDD)Date that funds are available for services.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`8`

PlanEndDate Date

(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`8`

FundsClearedDate Date

Date the funds cleared.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`8`

RejectDate Date

Funds reject date.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`8`

RejectNote Alphanu meric

Add a reject note to an employer deposit.

First Available Version:	EmployerDepositRequest _2018_10
Default Values:
Max Length:	`255`

HideFromReports Boolean

1. (No) – Will not hide this transaction from report
2. (Yes) – Transaction will be hidden from report

First Available Version:	EmployerDepositRequest _2018_10
Default Values:	`0`
Max Length:	`1`

Response Message: Empty Message Example of an EmployerDeposit 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>tzrzna45np5a1t55refepx3c</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body> <EmployerDeposit xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Request/2004/06/"> <employerDepositRequest>
    <BankAccountDisplayName>EASE10 Account</BankAccountDisplayName>
    <DepositAmount>1000</DepositAmount>
    <EmployerId>EASE10</EmployerId>
    <TpaId>T00209</TpaId>
</employerDepositRequest>
</EmployerDeposit>
</soap:Body>
</soap:Envelope>

Example of an EmployerDeposit 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>
        <EmployerDepositResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/"> <EmployerDepositResult />
    </EmployerDepositResponse>
</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 depositing or making a payment with an employer logical bank account using the EmployerDeposit web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.  mbiSessionHeader = new
    EmployerLogicalBankAccountServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new
        EmployerLogicalBankAccountServiceNameSpace.EmployerLogicalBankAccountService();
    // Create request message for method call (input parameters) request = new EmployerLogicalBankAccountServiceNameSpace.EmployerDepositRequest();
    // Set the input parameters request.EmployerId = _employerId.Text;   request.TpaId = _tpaId.Text;      request.BankAccountDisplayName = _b
    nkAccountDisplayName.Text;
    request.DepositAmount = Convert.ToDecimal(_depositAmount.Text);
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.EmployerDeposit(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

GetEmployerLogicalBankAccount

This method is used to retrieve an employer’s logical bank account information.

History

The GetEmployerLogicalBankAccount methods are listed below:

Request Message

GetEmployerLogicalBankAccountRequest

Response Message

GetEmployerLogicalBankAccountResponse_2022_10
GetEmployerLogicalBankAccountResponse_2022_05
GetEmployerLogicalBankAccountResponse_2020_02
GetEmployerLogicalBankAccountResponse_2018_10
GetEmployerLogicalBankAccountResponse_2015_10
GetEmployerLogicalBankAccountResponse

GetEmployerLogicalBankAccount - Request/Response Messages

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

The table below includes the following request message:

GetEmployerLogicalBankAccountRequest

Request Body

BankAccountDisplayName String required

Name associated with the logical bank account.

First Available Version:	GetEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`50`

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.

First Available Version:	GetEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`18`

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version:	GetEmployerLogicalBankAccountRequest
Max Length:

The table below includes the following response message:

GetEmployerLogicalBankAccountResponse_2022_10
GetEmployerLogicalBankAccountResponse_2022_05
GetEmployerLogicalBankAccountResponse_2020_02
GetEmployerLogicalBankAccountResponse_2018_10
GetEmployerLogicalBankAccountResponse_2015_10
GetEmployerLogicalBankAccountResponse

Response Body

AvailableBalance Decimal

Available balance on the account.

First Available Version: GetEmployerLogicalBankAccountResponse
BankAccountDisplayName String

Display name associated with the logical bank account.

First Available Version: GetEmployerLogicalBankAccountResponse
BankAccountStatusCode Enumeration

Status of the Logical Account.
New
Active
TempInactive
PermInactive
PendingValidation
ValidationRequired
FixAccount

First Available Version: GetEmployerLogicalBankAccountResponse
ConvenienceFeesPaid Boolean

Indicates if convenience fees are being paid on this employer account.

First Available Version: GetEmployerLogicalBankAccountResponse
InActivateEmployerIfBalanceDropsBelowZero Boolean

Indicates if employer status will change to "Inactive" in the case of the bank account balance dropping below zero.

First Available Version: GetEmployerLogicalBankAccountResponse
DefaultAccount Boolean

Indicates if this is a default account.

First Available Version: GetEmployerLogicalBankAccountResponse
DisbPtd Decimal

Disbursable balance paid to date.

First Available Version: GetEmployerLogicalBankAccountResponse
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.

First Available Version: GetEmployerLogicalBankAccountResponse
MinBalance ReceiveAlert Decimal

The dollar amount that, if the account balance goes below, will result in a balance alert.

First Available Version: GetEmployerLogicalBankAccountResponse
NextCheck Number Integer

Check number for reimbursement processing.

First Available Version: GetEmployerLogicalBankAccountResponse
PhysicalBank AccountName String

Name of the ACH account to which the employer group is associated.

First Available Version: GetEmployerLogicalBankAccountResponse
PreAuthBal Decimal

Balance of transactions that don’t have a matching forcepost.

First Available Version: GetEmployerLogicalBankAccountResponse
ReceiveAccountActivityViaEmail Address String

Email address of person selected to receive email of activity.

First Available Version: GetEmployerLogicalBankAccountResponse
ReceiveAccountActivityViaEmail Boolean

Indicates if daily account activity will be received via email.

First Available Version: GetEmployerLogicalBankAccountResponse
TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version: GetEmployerLogicalBankAccountResponse
TypeOfClaims Affected Enumeration

What type of claims should affect this account?
POS
Manual
All

First Available Version: GetEmployerLogicalBankAccountResponse
PlanType String

Type of benefit plan or account, such as FSA, DCA, or TRN.

First Available Version: GetEmployerLogicalBankAccountResponse
UseEmployerAccountCheckNumber Enumeration

Use check number above for reimbursement processing.
None
UseEmployerAccountCheckNumber
AllowInactiveEmployerStatus
IncludeBankNamePos
IncludeBankNameManual

First Available Version: GetEmployerLogicalBankAccountResponse
ZeroBalanceAccount Boolean

Indicates if this is a zero balance account. If true, POS claims are NOT authorized against the account.

First Available Version: GetEmployerLogicalBankAccountResponse
EnabledEmployerFunding Boolean

Indicates if employer funding is enabled on this logical account.

First Available Version: GetEmployerLogicalBankAccountResponse
EmployerFundingMethod Enumeration

If ‘Enabled Employer Funding Options’ is set to True, this value is required. This field defines the funding method used for employer funding.
None
Claim Activity Funding (default)
On-Demand
HSA Payroll Funding
Payroll Funding

First Available Version: GetEmployerLogicalBankAccountResponse
EmployerFundingNotificationToAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group.

First Available Version: GetEmployerLogicalBankAccountResponse
EmployerNotificationEmailCC Address String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via CC.

First Available Version: GetEmployerLogicalBankAccountResponse
EmployerFundingNotification BCCAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via BCC.

First Available Version: GetEmployerLogicalBankAccountResponse
EmployerFundingNotificationEmailSubject String

This field defines the subject of the email sent to employer groups communicating debits and credits to the employer funding account.

First Available Version: GetEmployerLogicalBankAccountResponse
FundingTemplateName String

This field should be used to name the Funding Template for employer funding.

First Available Version: GetEmployerLogicalBankAccountResponse
FundingBankAcctName String

This field should be used to name the Employer Funding Account used for employer funding.

First Available Version: GetEmployerLogicalBankAccountResponse
PhysicalBankAccountNameDD String

This is name of the physical bank account used for Direct Deposit processing.

First Available Version: GetEmployerLogicalBankAccountResponse
BeginningDate String

The begin date field is used by administrators to indicate when payroll deposits should start funding HSA accounts using the automated HSA funded functionality in WCA. Deposits inserted prior to the begin date will not be used as funding deposits.

First Available Version: GetEmployerLogicalBankAccountResponse
ProcessLogicalDeposits Boolean

If enabled, WCA will automatically credit the employer bank account for the amount of the claim activity funding NACHA file.
True = Process logical deposits upon completion of funding schedule
False = Do not process logical deposits upon completion of funding schedule

First Available Version: GetEmployerLogicalBankAccountResponse

CheckFileExportTemplat e String

This is the name of template used for Check File Export.

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

CheckPrintingTemplate String

This is the name of template used for Check Printing.

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

DirectDepositFileExportTemplate String

This is the name of template used for Direct Deposit File Export.

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

EmployerFunding Enumeration

This field is required if ‘EnableEmployerFunding’ is set to True. Values:
None
Claim Activity Funding (default)
On-Demand
HSA Payroll Funding
Payroll Funding

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

HSAFundingOption Enumeration

This field is required if ‘EmployerFunding’ is set to HSA Payroll Funding. Values:
Automated Settlement
Nacha Files

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

ReimbursementComment String

Reimbursement comment text.

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

ReimbursementSignature String

Reimbursement signature.

First Available Version:

GetEmployerLogicalBankAccountResponse_2015_10

DivisionName String

Notional account’s assigned division name.

First Available Version: GetEmployerLogicalBankAccountResponse
BillingGroup String

Notional account’s assigned billing group ID.

First Available Version: GetEmployerLogicalBankAccountResponse
AccountSegmentID String

Notional account’s assigned account segment ID.

First Available Version: GetEmployerLogicalBankAccountResponse
EnablEmployerHSAFundingManagement Boolean

This option enables the employer-level HSA funding account, on the employer level. Values: 0 – Disabled (default) 1 – Enabled

First Available Version: GetEmployerLogicalBankAccountResponse

ProcessLogicalDeposits Enumeration

0 – Never (default)
1 – Upon completion of funding schedule
2 – Upon funding clear date New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (never) if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (never).
If field is not included in the import, existing settings remain unchanged.

First Available Version:

GetEmployerLogicalBankAccountResponse_2018_10

EnableInvoicingOptions Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
If admin-level invoicing option is not enabled, an error is returned.
If a communication template is not enabled, an error is returned.
Note: If ‘process logical deposits upon fund clear date’ is selected, this option is defaulted to 1 (yes).

First Available Version:

GetEmployerLogicalBankAccountResponse_2018_10

SuppressNACHA Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ must be set to ‘yes’ to enable this setting. If not, an error is returned

First Available Version:

GetEmployerLogicalBankAccountResponse_2018_10

FundingClearedAlert Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ and ‘suppress NACHA’ both must be set to ‘yes’ to enable this setting. If not, errors are returned.

First Available Version:

GetEmployerLogicalBankAccountResponse_2018_10

TrackDueDate Boolean

0 – No (default)
1 – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ must be set to ‘yes’ to enable this setting. If not, an error is returned.

First Available Version:

GetEmployerLogicalBankAccountResponse_2018_10

InvoiceDueDate String

First Available Version:

GetEmployerLogicalBankAccountResponse_2018_10

ReimbursementScheduleOverride1 String

Optionally include the name of existing reimbursement schedule in WCA. WCA overrides any current/future reimbursement schedules assigned at the employer level and uses the schedule that is set using this field for all transactions affecting this notional account

First Available Version:

GetEmployerLogicalBankAccountResponse_2020_02

ReimbursementScheduleOverride2 String

First Available Version:

GetEmployerLogicalBankAccountResponse_2020_02

FundingType Short

First Available Version:

GetEmployerLogicalBankAccountResponse_2022_10

FundingAccountName String

The name of the funding account being used.

First Available Version:

GetEmployerLogicalBankAccountResponse_2022_10

IsRealTimeFunding Short

First Available Version:

GetEmployerLogicalBankAccountResponse_2022_10

CreditEmployerAccountBalance Short

0 – Never (default)
1 – Upon completion of funding schedule
2 – Upon funding clear date
Note: This field replaces 'process logical deposits'. ‘Process logical deposits’ may still appear on this service for now, but please use this field in its place.

First Available Version:

GetEmployerLogicalBankAccountResponse_2022_10

Example of a GetEmployerLogicalBankAccount 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>fbupfem0fgnf1m45snm4r345</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <GetEmployerLogicalBankAccount xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Request/2004/06/">
            <getEmployerLogicalBankAccountRequest>
                <BankAccountDisplayName>Test Bank Account</BankAccountDisplayName>
                <EmployerId>EASEEWEWE</EmployerId>
                <TpaId>T00209</TpaId>
            </getEmployerLogicalBankAccountRequest>
        </GetEmployerLogicalBankAccount>
    </soap:Body>
</soap:Envelope>
Example of a GetEmployerLogicalBankAccount 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>
        <GetEmployerLogicalBankAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/">
            <GetEmployerLogicalBankAccountResult>
                <AvailableBalance>0</AvailableBalance>
                <BankAccountDisplayName>Test Bank Account</BankAccountDisplayName>
                <BankAccountStatusCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</BankAccountStatusCode>
                <ConvenienceFeesPaid>true</ConvenienceFeesPaid>
                <DefaultAccount>false</DefaultAccount>
                <DisbPtd>0</DisbPtd>
                <EmployerId>EASEEWEWE</EmployerId>
                <MinBalanceReceiveAlert>5000.0000</MinBalanceReceiveAlert>
                <NextCheckNumber>1000</NextCheckNumber>
                <PhysicalBankAccountName>EASBankACC1</PhysicalBankAccountName>
                <PreAuthBal>0</PreAuthBal>
                <ReceiveAccountActivityViaEmailAddress>[email protected]</ReceiveAccountActivityViaEmailAddress>
                <ReceiveAccountActivityViaEmail>true</ReceiveAccountActivityViaEmail>
                <TpaId>T00209</TpaId>
                <TypeOfClaimsAffected xmlns="http://www.medibank.com/MBIWebServices/Enums/">Manual</TypeOfClaimsAffected>
                <UseEmployerAccountCheckNumber
                    xmlns="http://www.medibank.com/MBIWebServices/Enums/">UseEmployerAccountCheckNumber
                </UseEmployerAccountCheckNumber>
                <ZeroBalanceAccount>true</ZeroBalanceAccount>
            </GetEmployerLogicalBankAccountResult>
        </GetEmployerLogicalBankAccountResponse>
    </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 retrieving information about an employer’s logical bank account using the GetEmployerLogicalBankAccount web method.

try
{
    _dataset.Tables["EmployerLogicalBankAccount"].Clear();
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.  mbiSessionHeader = new
    EmployerLogicalBankAccountServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new
        EmployerLogicalBankAccountServiceNameSpace.EmployerLogicalBankAccountService();
    // Create request message for method call (input parameters)
    request = new
        EmployerLogicalBankAccountServiceNameSpace.GetEmployerLogicalBankAccountRequest();
    // Set the input parameters
    request.EmployerId = _employerId.Text;
    request.TpaId = _tpaId.Text;
    request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
    request.BankAccountDisplayName = _bankAccountDisplayName.Text;
    // session ID returned from logon method  mbiSessionHeader.MBISessionID = _sessionId.Text;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.GetEmployerLogicalBankAccount(request);
    if(response != null)
    {
        _dataset.Tables["EmployerLogicalBankAccount"].Rows.Add(new string[]
        {
            response.AvailableBalance.ToString(),
                response.BankAccountDisplayName,
                response.BankAccountStatusCode.ToString(),
                response.ConvenienceFeesPaid.ToString(),
                response.DefaultAccount.ToString(),
                response.DisbPtd.ToString(),
                response.EmployerId,
                response.MinBalanceReceiveAlert.ToString(),
                response.NextCheckNumber.ToString(),
                response.PhysicalBankAccountName,
                response.PreAuthBal.ToString(),
                response.ReceiveAccountActivityViaEmail.ToString(),
                response.ReceiveAccountActivityViaEmailAddress,
                response.TpaId,
                response.TypeOfClaimsAffected.ToString(),
                response.UseEmployerAccountCheckNumber.ToString(),
                response.ZeroBalanceAccount.ToString()
        });
    }
}

GetEmployerLogicalBankAccounts

This method is used to retrieve all the employer’s logical bank accounts.

History

The GetEmployerLogicalBankAccounts methods are listed below:

Request Message

GetEmployerLogicalBankAccountsRequest

Response Message

GetEmployerLogicalBankAccountsResponse_2022_10
GetEmployerLogicalBankAccountsResponse_2020_02
GetEmployerLogicalBankAccountsResponse_2018_10
GetEmployerLogicalBankAccountsResponse_2015_10
GetEmployerLogicalBankAccountsResponse

GetEmployerLogicalBankAccounts Request/Response Messages

The GetEmployerLogicalBankAccounts method requires the following request and response messages (input and output data). The table below includes the following request message:

GetEmployerLogicalBankAccountsRequest

Request Body

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.

First Available Version:	GetEmployerLogicalBankAccountsRequest
Default Values:
Max Length:	`18`

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version:	GetEmployerLogicalBankAccountsRequest
Max Length:

VerboseMode Boolean

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:	GetEmployerLogicalBankAccountsRequest
Default Values:	`FALSE`
Max Length:

The table below includes the following response message:

GetEmployerLogicalBankAccountsResponse_2022_10
GetEmployerLogicalBankAccountsResponse_2020_02
GetEmployerLogicalBankAccountsResponse_2018_10
GetEmployerLogicalBankAccountsResponse_2015_10
GetEmployerLogicalBankAccountsResponse

Response Body

EmployerFundingMethod Enumeration

If ‘Enabled Employer Funding Options’ is set to True, this value is required. This field defines the funding method used for employer funding.
None
Claim Activity Funding (default)
On-Demand
HSA Payroll Funding
Payroll Funding

First Available Version:

GetEmployerLogicalBankAccountsResponse

FundingNotificationToEmailAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group.

First Available Version:

GetEmployerLogicalBankAccountsResponse

FundingNotificationEmailCCAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via CC.

First Available Version:

GetEmployerLogicalBankAccountsResponse

FundingNotificationBCCAd dress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via BCC.

First Available Version:

GetEmployerLogicalBankAccountsResponse

FundingNotificationEmailSubject String

This field defines the subject of the email sent to employer groups communicating debits and credits to the employer funding account.

First Available Version:

GetEmployerLogicalBankAccountsResponse

FundingTemplateName String

This field should be used to name the Funding Template for employer funding.

First Available Version:

GetEmployerLogicalBankAccountsResponse

FundingBankAcctName String

This field should be used to name the Employer Funding Account used for employer funding.

First Available Version:

GetEmployerLogicalBankAccountsResponse

PhysicalBankAccountNameDD String

This is name of the physical bank account used for Direct Deposit processing.

First Available Version:

GetEmployerLogicalBankAccountsResponse

PhysicalBankAccountName String

Name of the ACH account to which the employer group is associated.

First Available Version:

GetEmployerLogicalBankAccountsResponse

BeginningDate String

First Available Version:

GetEmployerLogicalBankAccountsResponse

ProcessLogicalDeposits Boolean

If enabled, WCA will automatically credit the employer bank account for the amount of the claim activity funding NACHA file.
True = Process logical deposits upon completion of funding schedule
False = Do not process logical deposits upon completion of funding schedule

First Available Version:

GetEmployerLogicalBankAccountsResponse

AvailableBalance Decimal

Available balance in the account.

First Available Version:

GetEmployerLogicalBankAccountsResponse

PreAuthBal Decimal

Employer Account’s Pre-Authorization Balance.

First Available Version:

GetEmployerLogicalBankAccountsResponse

DisbPtd Decimal

Employer Account’s Disbursable Balance paid to date.

First Available Version:

GetEmployerLogicalBankAccountsResponse

DefaultAccount Boolean

Displays whether this employer account is the default employer account for the employer.
True = Yes, Default
False = Not default

First Available Version:

GetEmployerLogicalBankAccountsResponse

CheckFileExportTemplate String

This is the name of template used for Check File Export.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

CheckPrintingTemplate String

This is the name of template used for Check Printing.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

DirectDepositFileExportTemplate String

This is the name of template used for Direct Deposit File Export.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

EmployerFunding Enum

This field is required if ‘EnableEmployerFunding’ is set to True. Values:
None
Claim Activity Funding (default)
On-Demand
HSA Payroll Funding
Payroll Funding

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

HSAFundingOption Enum

This field is required if ‘EmployerFunding’ is set to HSA Payroll Funding. Values:
Automated Settlement
Nacha Files

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

ReimbursementComment String

Reimbursement comment text.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

ReimbursementSignature String

Reimbursement signature.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2015_10

DivisionName String

Notional account’s assigned division name.

First Available Version:

GetEmployerLogicalBankAccountsResponse

BillingGroup String

Notional account’s assigned billing group ID.

First Available Version:

GetEmployerLogicalBankAccountsResponse

AccountSegmentID String

Notional account’s assigned account segment ID.

First Available Version:

GetEmployerLogicalBankAccountsResponse

EnableEmployerHSAFundingManagement Boolean

This option enables the employer-level HSA funding account, on the employer level. Values: 0 – Disabled (default) 1 – Enabled

First Available Version:

GetEmployerLogicalBankAccountsResponse

ProcessLogicalDeposits Enumeration

1. – Never (default)
2. – Upon completion of funding schedule
3. – Upon funding clear date New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (never) if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (never).
If field is not included in the import, existing settings remain unchanged.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2018_10

EnableInvoicingOptions Boolean

1. – No (default)
2. – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
If admin-level invoicing option is not enabled, an error is returned.
If a communication template is not enabled, an error is returned.
Note: If ‘process logical deposits upon fund clear date’ is selected, this option is defaulted to 1 (yes).

First Available Version:

GetEmployerLogicalBankAccountsResponse_2018_10

SuppressNACHA Boolean

1. – No (default)
2. – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ must be set to ‘yes’ to enable this setting. If not, an error is returned.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2018_10

FundingClearedAlert Boolean

1. – No (default)
2. – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ and ‘suppress NACHA’ both must be set to ‘yes’ to enable this setting. If not, errors are returned.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2018_10

TrackDueDate Boolean

1. – No (default)
2. – Yes
New account:
If field is included in the import, account is set to the value entered.
Defaults to 0 (no), if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 0 (no).
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ must be set to ‘yes’ to enable this

First Available Version:

GetEmployerLogicalBankAccountsResponse_2018_10

InvoiceDueDate String

Specify number of days; 1 (default) through 5 New account:
If field is included in the import, account is set to the value entered.
Defaults to 1 if no value is entered or field is not included.
Update account:
If field is included in the import, account is set to the value entered.
If field is included but no value is entered, account is set to 1.
If field is not included in the import, existing settings remain unchanged.
‘Enable invoicing options’ and ‘track due date’ both must be set to ‘yes’ to enable this setting. If not, errors are returned.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2018_10

ReimbursementScheduleOverride1 String

Optionally include the name of existing reimbursement schedule in WCA. WCA overrides any current/future reimbursement schedules assigned at the employer level and uses the schedule that is set using this field for all transactions affecting this notional account.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2022_02

ReimbursementScheduleOverride2 String

First Available Version:

GetEmployerLogicalBankAccountsResponse_2022_02

FundingType Short

First Available Version:

GetEmployerLogicalBankAccountsResponse_2022_10

FundingAccountName String

Name of the funding account.

First Available Version:

GetEmployerLogicalBankAccountsResponse_2022_10

IsRealTimeFunding Short

First Available Version:

GetEmployerLogicalBankAccountsResponse_2022_10

CreditEmployerAccountBalance Short

First Available Version:

GetEmployerLogicalBankAccountsResponse_2022_10

Example GetEmployerLogicalBankAccounts 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>fbupfem0fgnf1m45snm4r345</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <GetEmployerLogicalBankAccounts xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Request/2004/06/"> <getEmployerLogicalBankAccountsRequest>
        <EmployerId>EASE10</EmployerId>
        <TpaId>T00209</TpaId>
    </getEmployerLogicalBankAccountsRequest>
</GetEmployerLogicalBankAccounts>
</soap:Body>
</soap:Envelope>

Example of GetEmployerLogicalBankAccounts 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>
        <GetEmployerLogicalBankAccountsResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/"> <GetEmployerLogicalBankAccountsResult>
        <GetEmployerLogicalBankAccountsResponse>
            <BankAccountDisplayName>EASE10 Account</BankAccountDisplayName>
            <BankAccountStatusCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</BankAccountStatusCode> \
            <ConvenienceFeesPaid>false</ConvenienceFeesPaid>
            <EmployerId>EASE10</EmployerId>
            <MinBalanceReceiveAlert>0</MinBalanceReceiveAlert>
            <NextCheckNumber>-1</NextCheckNumber>
            <ReceiveAccountActivityViaEmailAddress />
            <ReceiveAccountActivityViaEmail>false</ReceiveAccountActivityViaEmail>
            <TpaId>T00209</TpaId>
            <TypeOfClaimsAffected xmlns="http://www.medibank.com/MBIWebServices/Enums/">All</TypeOfClaimsAffected>
            <UseEmployerAccountCheckNumber xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</UseEmployerAccountCheckNumber>
            <ZeroBalanceAccount>false</ZeroBalanceAccount>
        </GetEmployerLogicalBankAccountsResponse>
        <GetEmployerLogicalBankAccountsResponse>
            <BankAccountDisplayName>EASE10 Account 2</BankAccountDisplayName>
            <BankAccountStatusCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</BankAccountStatusCode>
            <ConvenienceFeesPaid>false</ConvenienceFeesPaid>
            <EmployerId>EASE10</EmployerId>
            <MinBalanceReceiveAlert>0</MinBalanceReceiveAlert>
            <NextCheckNumber>-1</NextCheckNumber>
            <ReceiveAccountActivityViaEmailAddress /> \
            <ReceiveAccountActivityViaEmail>false</ReceiveAccountActivityViaEmail>
            <TpaId>T00209</TpaId>
            <TypeOfClaimsAffected xmlns="http://www.medibank.com/MBIWebServices/Enums/">Manual</TypeOfClaimsAffected>
            <UseEmployerAccountCheckNumber xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</UseEmployerAccountCheckNumber>
            <ZeroBalanceAccount>false</ZeroBalanceAccount>
        </GetEmployerLogicalBankAccountsResponse>
    </GetEmployerLogicalBankAccountsResult>
</GetEmployerLogicalBankAccountsResponse>
</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 retrieving a list of employer’s logical bank accounts using the GetEmployerLogicalBankAccounts web method.

try
{
    _dataset.Tables["EmployerLogicalBankAccounts"].Clear();
    mbiSessionHeader = new
        EmployerLogicalBankAccountServiceNameSpace.MBISessionHeader();
    proxy = new
        EmployerLogicalBankAccountServiceNameSpace.EmployerLogicalBankAccountService();
    request = new
        EmployerLogicalBankAccountServiceNameSpace.GetEmployerLogicalBankAccountsRequest();
    request.TpaId = _tpaId.Text;  request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);   request.EmployerId = _employerId.Text;
    // session ID returned from logon method  mbiSessionHeader.MBISessionID = _sessionId.Text;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    responses = proxy.GetEmployerLogicalBankAccounts(request);
    if(responses != null)
    {
        for(int i=0; i < responses.Length; i++)
        {
            _dataset.Tables["EmployerLogicalBankAccounts"].Rows.Add( new string[]
            {
                responses[i].BankAccountDisplayName,
                    responses[i].BankAccountStatusCode.ToString(),
                    responses[i].ConvenienceFeesPaid.ToString(),
                    responses[i].EmployerId,
                    responses[i].MinBalanceReceiveAlert.ToString(),
                    responses[i].NextCheckNumber.ToString(),
                    responses[i].ReceiveAccountActivityViaEmail.ToString(),
                    responses[i].ReceiveAccountActivityViaEmailAddress,
                    responses[i].TpaId,
                    responses[i].TypeOfClaimsAffected.ToString(),
                    responses[i].UseEmployerAccountCheckNumber.ToString(),
                    responses[i].ZeroBalanceAccount.ToString()
            });
        }
    }

UpdateEmployerLogicalBankAccount

This method is used to update an employer’s logical bank account information.

History

The UpdateEmployerLogicalBankAccount methods are listed below:

Request Message

UpdateEmplo yerLogicalBankAccountRequest_2022_10
UpdateEmployerLogicalBankAccountsRequest_2022_05
UpdateEmployerLogicalBankAccountsRequest_2018_10
UpdateEmployerLogicalBankAccountRequest Response Message

Response Message

UpdateEmployerLogicalBankAccountResponse

UpdateEmployerLogicalBankAccount Request/Response Messages

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

The table below includes the following request message:

UpdateEmplo yerLogicalBankAccountRequest_2022_10
UpdateEmployerLogicalBankAccountsRequest_2022_05
UpdateEmployerLogicalBankAccountsRequest_2018_10
UpdateEmployerLogicalBankAccountRequest

Request Body

BankAccountDisplayName String required

Display name associated with the logical bank account.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`50`

BankAccountStatusCode Enumeration required

Status of the Logical Account.
New
Active
TempInactive
PermInactive
PendingValidation
ValidationRequired
FixAccount

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`New`
Max Length:

ConvenienceFeesPaid Boolean

Indicates if convenience fees are being paid on this employer account.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

InActivateEmployerIfBalanceDropsBelowZero Boolean

Should WCA Temp Inactivate an Employer, if the Logical Account balance drops below $0.00?

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

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.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`18`

MinBalanceReceiveAlert Decimal

The dollar amount that, if the account balance goes below, will result in a balance alert.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`10000`
Max Length:

NextCheckNumber Integer

Check number for reimbursement processing.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

NewBankAccountDisplayName String

Leave empty unless changing BankAccountDisplayName.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:	`50`

PhysicalBankAccountName String required

Name of the ACH account to which the employer group is associated.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

ReceiveAccountActivityViaEmailAddress String

Email address of person selected to receive activity emails.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

ReceiveAccountActivityViaEmail Boolean

Indicates if daily account activity will be received via email.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

TypeOfClaims Affected Enumeration

What type of claims should affect this account?
POS
Manual
All

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`All`
Max Length:

PlanType String

Type of benefit plan or account, such as FSA, DCA, or TRN.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

UseEmployerAccountCheckNumber Boolean

Indicates if Employer Account specified check number will be used for reimbursement processing.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

ZeroBalanceAccount Boolean required

Indicates if this is a zero balance account. If true, POS claims are NOT authorized against the account.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`TRUE`
Max Length:

EnableEmployerFunding Boolean

Indicates if employer funding is enabled on this logical account.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

FundingNotificationToAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingNotificationCCAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via CC.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingNotificationBCCAddress String

This field is not required to utilize the Employer Funding feature. The email address is used to communicate debit and credit information to the employer group via BCC.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingNotificationSubject String

This field defines the subject of the email sent to employer groups communicating debits and credits to the employer funding account.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingTemplateName String

This field should be used to name the Funding Template for employer funding.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

FundingBankAcctName String

This field should be used to name the Employer Funding Account used for employer funding.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

PhysicalBankAccountNameDD String

This is name of the physical bank account used for Direct Deposit processing.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

TrackingNumber String

The tracking number is used to identify request. If this field is sent with a request, WCA will return this value in the response.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:
Max Length:

ProcessLogicalDeposits Boolean

Determines whether to process logical deposits upon completion of a Claims Based funding schedule. Requires a Claim Activity Funding Template be assigned to the Logical Account.

First Available Version:	UpdateEmployerLogicalBankAccountRequest
Default Values:	`FALSE`
Max Length:

BeginningDate String

First Available Version:	UpdateEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

CheckFileExportTemplate String

This is the name of template used for Check File Export.

First Available Version:	UpdateEmployerLogicalBankAccountRequest_2010_10
Default Values:
Max Length:

Response Message: Empty Message Example

of an UpdateEmployerLogicalBankAccount 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>tzrzna45np5a1t55refepx3c</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <UpdateEmployerLogicalBankAccount xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Request/2004/06/">
            <updateEmployerLogicalBankAccountRequest>
                <BankAccountDisplayName>Test Bank Account</BankAccountDisplayName>
                <BankAccountStatusCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</BankAccountStatusCode>
                <ConvenienceFeesPaid>true</ConvenienceFeesPaid>
                <EmployerId>EASEEWEWE</EmployerId>
                <MinBalanceReceiveAlert>5000.0000</MinBalanceReceiveAlert>
                <NextCheckNumber>1000</NextCheckNumber>
                <PhysicalBankAccountName>EASBankACC1</PhysicalBankAccountName>
                <ReceiveAccountActivityViaEmailAddress>[email protected]</ReceiveAccountActivityViaEmailAddress>
                <ReceiveAccountActivityViaEmail>true</ReceiveAccountActivityViaEmail>
                <TpaId>T00209</TpaId>
                <TypeOfClaimsAffected xmlns="http://www.medibank.com/MBIWebServices/Enums/">Manual</TypeOfClaimsAffected>
                <UseEmployerAccountCheckNumber xmlns="http://www.medibank.com/MBIWebServices/Enums/">UseEmployerAccountCheckNumber
            </UseEmployerAccountCheckNumber>
        </updateEmployerLogicalBankAccountRequest>
    </UpdateEmployerLogicalBankAccount>
</soap:Body>
</soap:Envelope>

Example of an UpdateEmployerLogicalBankAccount 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>
        <UpdateEmployerLogicalBankAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/">
            <UpdateEmployerLogicalBankAccountResult />
        </UpdateEmployerLogicalBankAccountResponse>
    </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 updating an employer’s logical bank account information using the UpdateEmployerLogicalBankAccount web method.

try
{
    mbiSessionHeader = new EmployerLogicalBankAccountServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new EmployerLogicalBankAccountServiceNameSpace.EmployerLogicalBankAccountService();
    // Create request message for method call (input parameters)  request = new EmployerLogicalBankAccountServiceNameSpace.UpdateEmployerLogicalBankAccountRequest();
    request.BankAccountDisplayName = _bankAccountDisplayName.Text;
    request.BankAccountStatusCode = (EmployerLogicalBankAccountServiceNameSpace.BankAccountStatus) _bankAccountStatusCode.SelectedItem;
    request.ConvenienceFeesPaid = (bool) _convenienceFeesPaid.SelectedItem;   request.EmployerId = _employerId.Text;
    if(_minBalanceReceievAlert.Text.Length > 0)
    {
        request.MinBalanceReceiveAlert = Convert.ToDecimal(_minBalanceReceievAlert.Text);
    }
    request.NewBankAccountDisplayName = _newBankAccountDisplayName.Text;
    if(_nextCheckNumber.Text.Length > 0)
    {
        request.NextCheckNumber = Convert.ToInt32(_nextCheckNumber.Text);
        request.NextCheckNumberSpecified = true;
    }
    request.PhysicalBankAccountName = _physicalBankAccountName.Text;                       request.ReceiveAccountActivityViaEmail = (bool)_receiveAccountActivityViaEmail.SelectedItem;
    request.ReceiveAccountActivityViaEmailAddress = _receiveAccountActivityEmailAddress.Text;   request.TpaId = _tpaId.Text;
    request.TypeOfClaimsAffected = (EmployerLogicalBankAccountServiceNameSpace.BankAccountUsage)
    _typeOfClaimsAffected.SelectedItem;
    request.UseEmployerAccountCheckNumber =
        (EmployerLogicalBankAccountServiceNameSpace.EmployerAccountOptions)
        _useEmployerAccountCheckNumber.SelectedItem;
    request.ZeroBalanceAccount = (bool) _zeroBalanceAccount.SelectedItem;
    mbiSessionHeader.MBISessionID = _sessionId.Text;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    response = proxy.UpdateEmployerLogicalBankAccount(request);   MessageBox.Show("Finished.");                                          }

Employer Logical Bank Account API | Administrative - SOAP

AddEmployerLogicalBankAccount

Request Body

DeleteEmployerLogicalBankAccount

Request Body

EmployerDeposit

Request Body

GetEmployerLogicalBankAccount

Request Body

Response Body

GetEmployerLogicalBankAccounts

Request Body

Response Body

UpdateEmployerLogicalBankAccount

Request Body

AI Assistant Preview

AI Assistant ^Preview