Transaction API | Administrative - SOAP
The transaction service provides clients transactional functionalities such as deposits, claims, and viewing transaction history.
Important note: In order to facilitate backward compatibility with all web services in use prior to June 4, 2005, either employee (dependent), social security number, or employee (dependent) ID may be provided when required to uniquely identify an employee or dependent. If both are provided, the employee (dependent) ID is used as the unique identifier.
Note: Every method on the transaction service has been converted to the Windows Communication Foundation architecture. To make use of the technology, the following URL should be used:
https://www.mbiwebservices.com/MBIWebServices/Transactions/Services/TransactionService.svc
Service Web Methods
The following is a list of methods that is
provided by the transaction service.
-
DepositPayroll – used to deposit funds to an employee’s benefit account.
-
DepositPrefunded – used to deposit funds to an employee’s benefit account.
-
GetTransactionHistory – used to view past POS transactions for an employee.
-
GetTransactionDetails – used to view details for a given transaction.
-
SubmitManualClaim – used to process manual claims (non-POS claims).
-
SubmitManualRefund – used to process manual claims (non-POS claims).
-
GetDisbursableBalanceAffectingTxns - This method is used to retrieve a list of transactions that result in updating disbursable balance on the account within the last 30 days
-
GetDisbursableBalanceAffectingTotal - This method is used to retrieve a total amount of balance affecting transactions (as defined above) for the day.
-
OtherDeposit – This method is used to do a special / other deposit to an employee’s benefit account. This is an employer deposit made to employee’s account like incentives or interest.
-
GetRecentTransactions – This method is used to retrieve a listing of up to the ten most recent transactions for a specific employee or dependent.
-
GetTransactionbyTN - This method is used to retrieve transaction information using the tracking number as the identifier
-
SubmitParticipantClaim - This method is used to submit a claim for a participant
-
SubmitDocument - This method is used to attach a document, such as a receipt, to a participant's transaction
-
SubmitParticipantClaimDocument - This method is used to attach a document, such as a receipt, to a participant's claim
Service Assumptions/Business Rules
The transaction 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 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.
Deposit Payroll
This method is
used to deposit funds to an employee’s benefit account by way of a payroll
deposit. Negative deposit amounts (adjustments) could be applied using
this method, lowering the employee’s benefit account balance.
-
Set account type, account type start date, and account type end date to describe the account in which to make the deposit for an employee.
-
WCA does not check for duplicate employee deposits. It is the responsibility of the calling application not to send duplicate employee deposits
History
The DepositPayroll methods are listed below:
Request Messages
-
DepositPayrollRequest_2010_04
-
DepositPayrollRequest_2006_05
-
DepositPayrollRequest
Response Messages
-
DepositPayrollResponse
DepositPayroll Request/Response Messages
The DepositPayroll
method requires the following request and response messages (input and
output data).
The table below includes the following request messages:
-
DepositPayrollRequest_2010_04
-
DepositPayrollRequest_2006_05
-
DepositPayrollRequest
Response Message: Empty Message
Example of a DepositPayroll SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<DepositPayroll
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<depositPayrollRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/05/" i:type="d4p3:DepositPayroll_2006_05">
<d4p1:AccountTypeCode>FSA</d4p1:AccountTypeCode>
<d4p1:AccountTypeEndDate>20091231</d4p1:AccountTypeEndDate>
<d4p1:AccountTypeStartDate>20090101</d4p1:AccountTypeStartDate>
<d4p1:DisplayDate>2009-04-07T10:44:00</d4p1:DisplayDate>
<d4p1:DisplayToCardholder>false</d4p1:DisplayToCardholder>
<d4p1:EmployeeDepositAmount>0</d4p1:EmployeeDepositAmount>
<d4p1:EmployeeId>Employee1</d4p1:EmployeeId>
<d4p1:EmployeeSocialSecurityNumber>333333333</d4p1:EmployeeSocialSecurityNumber>
<d4p1:EmployerDepositAmount>0</d4p1:EmployerDepositAmount>
<d4p1:EmployerId>WWW123</d4p1:EmployerId>
<d4p1:Note>Notes</d4p1:Note>
<d4p1:TpaId>T00111</d4p1:TpaId>
<d4p3:PlanId>FSA1</d4p3:PlanId>
</depositPayrollRequest>
</DepositPayroll>
</s:Body>
</s:Envelope>
Example of a DepositPayroll SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header />
<s:Body>
<DepositPayrollResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<DepositPayrollResult i:type="b:DepositPayrollResponse_2006_05"
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2006/05/" /> </DepositPayrollResponse>
</s:Body>
</s:Envelope>
Example client code
The following is an example of the client code
(using a .NET proxy class for accessing the service) used when submitting a
deposit to the DepositPayroll web method:
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.DepositPayrollRequest_2006_05 request = new
localhost.DepositPayrollRequest_2006_05();
// set the parameters for the web method call
request.AccountTypeCode = "DCA";
request.AccountTypeEndDate = "20031231";
request.AccountTypeStartDate = "20030101";
request.DisplayDate = new DateTime(2004,3,16);
request.DisplayToCardholder = true;
request.EmployeeDepositAmount = 100;
request.EmployeeSocialSecurityNumber = "333333333";
request.EmployerDepositAmount = 54.54M;
request.EmployerId = "BCBOOOOOO";
request.Note = "This is a test";
request.TpaId = "TPA123";
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
// Call the web method.
proxy.DepositPayroll(request);
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
DepositPrefunded
This method is
used to deposit funds to an employee’s benefit account by way of prefunded
deposits. Below are some points of interest about the method.
-
Pre-funded deposits are adjustments to the pre-funded amount.
-
Example 1: An employee has $1000 in their FSA and wished to increase that amount to $1500. A $500 pre-funded deposit must be made.
-
Example 2: An employee is supposed to have $800 in their FSA but the account incorrectly lists $1000. A pre-funded deposit for -$200 must be made.
-
-
Set account type, account type start date, and account type end date to describe the account in which to make the deposit for an employee.
-
WCA does not check for duplicate employee prefunded deposits. It is the responsibility of the calling application not to send duplicate requests.
History
The DepositPrefunded methods are listed below:
Request Messages
-
DepositPrefundedRequest_2010_04
-
DepositPrefundedRequest_2008_07
-
DepositPrefundedRequest_2006_12
-
DepositPrefundedRequest_2006_05
-
DepositPrefundedRequest
Response Messages
-
DepositPrefundedResponse
DepositPrefunded Request/Response Messages
The DepositPrefunded
method requires the following request and response messages (input and
output data).
The table below includes the following request messages:
-
DepositPrefundedRequest_2010_04
-
DepositPrefundedRequest_2008_07
-
DepositPrefundedRequest_2006_12
-
DepositPrefundedRequest_2006_05
-
DepositPrefundedRequest
Response Message: Empty Message
Example of a DepositPrefunded SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<DepositPrefunded
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<depositPrefundedRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/" i:type="d4p3:DepositPrefunded_2008_07">
<d4p1:AccountTypeCode>FSA</d4p1:AccountTypeCode>
<d4p1:AccountTypeEndDate>20091231</d4p1:AccountTypeEndDate>
<d4p1:AccountTypeStartDate>20090101</d4p1:AccountTypeStartDate>
<d4p1:DisplayDate>2009-04-07T10:49:00</d4p1:DisplayDate>
<d4p1:DisplayToCardholder>false</d4p1:DisplayToCardholder>
<d4p1:EmployeeId>Employee</d4p1:EmployeeId>
<d4p1:EmployeeSocialSecurityNumber>333333333</d4p1:EmployeeSocialSecurityNumber>
<d4p1:EmployerId>www133</d4p1:EmployerId>
<d4p1:Note>Notes</d4p1:Note>
<d4p1:PrefundedAdjustmentAmount>0</d4p1:PrefundedAdjustmentAmount>
<d4p1:TpaId>T00111</d4p1:TpaId>
<FamilyMemberId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/05/">FF</Famil yMemberId>
<HraDepositType
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/05/">FamilyAm ountPrefund</HraDepositType>
<PlanId i:nil="true"
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/05/" />
<OverrideAmountFlag
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/12/">false</Ov errideAmountFlag>
<d4p3:CoveragePeriodDate>2009-04-07T10:48:00</d4p3:CoveragePeriodDate>
<d4p3:OverrideSuspendActivity>false</d4p3:OverrideSuspendActivity>
</depositPrefundedRequest>
</DepositPrefunded>
</s:Body>
</s:Envelope>
Example of a DepositPrefunded SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header />
<s:Body>
<DepositPrefundedResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<DepositPrefundedResult
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" />
</DepositPrefundedResponse>
</s:Body>
</s:Envelope>
Example client code
The following is an example of the client code
(using a .NET proxy class to connect with the service) used when submitting
an amount to the DepositPrefunded method:
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.DepositPrefundedRequest_2006_12 request =
new localhost.DepositPrefundedRequest_2006_12();
// set the parameters for the web method call
request.AccountTypeCode = "ORT";
request.AccountTypeEndDate = "20041231";
request.AccountTypeStartDate = "20040101";
request.DisplayDate = new DateTime(2004,3,16);
request.DisplayToCardholder = true;
request.EmployeeSocialSecurityNumber = "333333333";
request.PrefundedAdjustmentAmount = 54.54M;
request.EmployerId = "BCBOOOOOO";
request.Note = "This is a test";
request.TpaId = "TPA123";
request.OverrideAmountFlag = false;
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls. sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
// Call the web method.
proxy.DepositPrefunded(request);
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetTransactionHistory
This method
is used to retrieve transactional information for an employee’s benefit
account.
History
The GetTransactionHistory methods are listed below:
Request Messages
-
GetTransactionHistory_2011_10
-
GetTransactionHistory_2010_10
-
GetTransactionHistory_2007_12
-
GetTransactionHistoryRequest_2006_05
-
GetTransactionHistoryRequest
Response Messages
-
GetTransactionHistoryResponse_2013_02
-
GetTransactionHistoryResponse_2012_10
-
GetTransactionHistoryResponse_2012_03
-
GetTransactionHistoryResponse_2010_10
-
GetTransactionHistoryResponse_2008_07
-
GetTransactionHistoryResponse_2007_12
-
GetTransactionHistoryResponse_2006_05
-
GetTransactionHistoryResponse
GetTransactionHistory Request/Response Messages
The
GetTransactionHistory method requires the following request and response
messages (input and output data).
The table below includes the following request messages:
-
GetTransactionHistoryRequest_2010_10
-
GetTransactionHistoryRequest_2007_12
-
GetTransactionHistoryRequest_2006_05
-
GetTransactionHistoryRequest
The table below includes the following response messages:
-
GetTransactionHistoryResponse_2012_10
-
GetTransactionHistoryResponse_2012_03
-
GetTransactionHistoryResponse_2010_10
-
GetTransactionHistoryResponse_2008_07
-
GetTransactionHistoryResponse_2007_12
-
GetTransactionHistoryResponse_2006_05
-
GetTransactionHistoryResponse
GetTransactionDetails
This is used to retrieve detail about a transaction.
History
The GetTransactionDetails methods are listed below:
Request Messages
-
GetTransactionDetailsRequest_2013_02
-
GetTransactionDetailsRequest_2012_10
-
GetTransactionDetailsRequest_2007_12
-
GetTransactionDetailsRequest
Response Messages
-
GetTransactionDetailsResponse_2021_02
-
GetTransactionDetailsResponse_2016_06
-
GetTransactionDetailsResponse_2015_02
-
GetTransactionDetailsResponse_2013_06
-
GetTransactionDetailsResponse_2013_02
-
GetTransactionDetailsResponse_2012_10
-
GetTransactionDetailsResponse_2012_03
-
GetTransactionDetailsResponse_2010_10
-
GetTransactionDetailsResponse_2010_04
-
GetTransactionDetailsResponse_2009_04
-
GetTransactionDetailsResponse_2008_07
-
GetTransactionDetailsResponse_2007_12
-
GetTransactionDetailsResponse
GetTransactionDetails Request/Response Messages
The
GetTransactionDetails method requires the following request and response
messages (input and output data).
The table below includes the following request messages:
-
GetTransactionDetailsRequest_2013_02
-
GetTransactionDetailsRequest_2012_10
-
GetTransactionDetailsRequest_2007_12
-
GetTransactionDetailsRequest
The table below includes the following response messages:
-
GetTransactionDetailsResponse_2021_02
-
GetTransactionDetailsResponse_2016_06
-
GetTransactionDetailsResponse_2015_02
-
GetTransactionDetailsResponse_2013_06
-
GetTransactionDetailsResponse_2013_02
-
GetTransactionDetailsResponse_2012_10
-
GetTransactionDetailsResponse_2012_03
-
GetTransactionDetailsResponse_2010_10
-
GetTransactionDetailsResponse_2010_04
-
GetTransactionDetailsResponse_2009_04
-
GetTransactionDetailsResponse_2008_07
-
GetTransactionDetailsResponse_2007_12
-
GetTransactionDetailsResponse
Example of a GetTransactionDetails SOAP request message:
Coming soon!
Example of a GetTransactionDetails SOAP response message:
Coming soon!
Example client code
The following is an example of the client code
(using a .NET proxy class to connect to the service) used when submitting a
claim to the GetTransactionDetails method.
Coming soon!
SubmitManualClaim
When processing
manual claims (non-POS claims), you must import the claim into WCA to verify
available funds prior to cutting a check to the employee. Below are some
points of interest about the method.
-
The tracking number field may be used by the administrator for any reason. Alegeus does not use the field. Some administrators use the tracking number for claim numbers.
-
If a claim is denied due to insufficient funds and the account allows for partial transaction then the transaction is re-submitted using the available amount. Note that if the second transaction was successful, then a warning is returned.
-
WCA does not check for duplicate manual transactions through the data transfer process. It is the responsibility of the calling application not to send duplicate manual transactions.
History
The SubmitManualClaim methods are listed below:
Request Messages
-
SubmitManualClaim_2013_06
-
SubmitManualClaim_2012_10
-
SubmitManualClaim_2011_12
-
SubmitManualClaim_2011_10
-
SubmitManualClaim_2010_10
-
SubmitManualClaim_2009_04
-
SubmitManualClaim_2008_07
-
SubmitManualClaim_2007_12
-
SubmitManualClaimRequest_2006_05
-
SubmitManualClaimRequest
Response Messages
-
SubmitManualClaimResponse
SubmitManualClaim Request/Response Messages
The SubmitManualClaim
method requires the following request and response messages (input and
output data).
The table below includes the following request messages:
-
SubmitManualClaim_2010_10
-
SubmitManualClaim_2009_04
-
SubmitManualClaim_2008_07
-
SubmitManualClaim_2007_12
-
SubmitManualClaimRequest_2006_05
-
SubmitManualClaimRequest.
The table below includes the following response messages:
-
SubmitManualClaimResponse_2009_04
Example of a SubmitManualClaim SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<SubmitManualClaim
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<submitManualClaimRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2009/04/" i:type="d4p3:SubmitManualClaim_2009_04">
<d4p1:AccountTypeCode>FSA</d4p1:AccountTypeCode>
<d4p1:ApprovedClaimAmount>90</d4p1:ApprovedClaimAmount>
<d4p1:CardNumber i:nil="true" />
<d4p1:CardholderId>Emp1</d4p1:CardholderId>
<d4p1:CardholderSocialSecurityNumber i:nil="true" />
<d4p1:DateOfServiceFrom>2009-03-10T15:44:00</d4p1:DateOfServiceFrom>
<d4p1:DateOfServiceTo>2009-03-10T15:44:00</d4p1:DateOfServiceTo>
<d4p1:DeniedClaimAmount>0</d4p1:DeniedClaimAmount>
<d4p1:DeniedReasonCode>22</d4p1:DeniedReasonCode>
<d4p1:DisplayDate>2009-04-07T11:22:00</d4p1:DisplayDate>
<d4p1:DisplayToCardholder>false</d4p1:DisplayToCardholder>
<d4p1:EmployerId>WWW5148</d4p1:EmployerId>
<d4p1:MerchantId>merchid</d4p1:MerchantId>
<d4p1:MerchantName>name</d4p1:MerchantName>
<d4p1:MerchantTypeCode>code</d4p1:MerchantTypeCode>
<d4p1:Note>note</d4p1:Note>
<d4p1:PlanYearEndDate>2009-04-07T11:22:00</d4p1:PlanYearEndDate>
<d4p1:PlanYearStartDate>2009-04-07T11:22:00</d4p1:PlanYearStartDate>
<d4p1:ReimbursementMode>None</d4p1:ReimbursementMode>
<d4p1:TpaId>T00411</d4p1:TpaId>
<d4p1:TrackingNumber>3333</d4p1:TrackingNumber>
<PlanId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/05/">FSA1</Pl anId>
<AllowOnhold
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2007/12/">false</Allo wOnhold>
<CheckEligibility
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2007/12/">false</Ch eckEligibility>
<EligibleForPosOffset
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2007/12/">false</Elig ibleForPosOffset>
<CheckAcctEligibility
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</Ch eckAcctEligibility>
<CheckGenerateDenialLetter
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</Ch eckGenerateDenialLetter>
<IsBypassDeductible
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</IsB ypassDeductible>
<OverrideSuspendActivity
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</Ov errideSuspendActivity>
<ScCde
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">scc</ScC de>
<d4p3:CrossOverClaim>false</d4p3:CrossOverClaim>
</submitManualClaimRequest>
</SubmitManualClaim>
</s:Body>
</s:Envelope
Example of a SubmitManualClaim SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiWarningsHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBIWarnings xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">
<MBIWarningsHeader.MBIWarning>
<Code>101004</Code>
<Message>Your disbursable balance for FSA account is $4,608.22</Message>
</MBIWarningsHeader.MBIWarning>
<MBIWarningsHeader.MBIWarning>
<Code>101007</Code>
<Message>Approved Amount is $90.00</Message>
</MBIWarningsHeader.MBIWarning>
</MBIWarnings>
</mbiWarningsHeader>
</s:Header>
<s:Body>
<SubmitManualClaimResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1"> <SubmitManualClaimResult i:type="b:SubmitManualClaimResponse_2009_04" xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2009/04/"> <b:ErrorCode>0</b:ErrorCode>
<b:TrackingNumber />
<b:TxnAmtOrig>90</b:TxnAmtOrig>
<b:TxnResponseList>
<b:ResponseAccount_2009_04>
<b:AcctTypeCde>FSA</b:AcctTypeCde>
<b:DisbBal>4608.22</b:DisbBal>
<b:TxnAmt>90.00</b:TxnAmt>
</b:ResponseAccount_2009_04>
</b:TxnResponseList>
</SubmitManualClaimResult>
</SubmitManualClaimResponse>
</s:Body>
</s: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 submitting a
claim to the SubmitManualClaim method.
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.SubmitManualClaimRequest_2006_05 request = new localhost.SubmitManualClaimRequest_2006_05();
// Array for any warnings returned
localhost.MBIWarning[] mbiWarnings;
// set the parameters for the web method call
request.AccountTypeCode = "DCA";
request.DateOfServiceTo = new DateTime(2003,12,15);
request.DateOfServiceFrom = new DateTime(2003,12,15);
request.DisplayDate = new DateTime(2004,3,16);
request.DisplayToCardholder = true;
request.ApprovedClaimAmount = 0M;
request.DeniedClaimAmount = 10M;
request.CardholderSocialSecurityNumber = "111111111";
request.EmployerId = "BCBOOOOOO";
request.Note = "This is a test";
request.TpaId = "TPA123";
request.DeniedReasonCode = "0001";
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls. sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
proxy.SubmitManualClaim(request);
// Test if any warnings were returned
if(proxy.MBIWarningsHeaderValue!=null)
{
mbiWarnings = proxy.MBIWarningsHeaderValue.MBIWarnings;
for(int i=0; i < mbiWarnings.Length; i++)
{
// perform needed operations
}
}
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
SubmitManualRefund
The
SubmitManualRefund method adds a given amount of money to an employee’s
account. Below are some points of interest about the method.
-
Set account type to help determine the account to apply the manual transaction against. The plan year start date and plan year end date fields are not required for this record since the date of service field is used to locate the valid start and end date if the plan start and end dates are not provided. If valid dates are not found, Alegeus provides an error code.
-
Set the employee social security number or the employee card number or the employee ID.
-
Set the merchant type code only if the plan has maximum amounts on individual MTC codes. The value does not need to match any existing MTC.
-
Set dates of service.
-
Set transaction amount.
-
The tracking number field may be used by the administrator for any reason. Alegeus does not use this field. Some administrators use the tracking number for claim numbers.
-
The refund amount should not be a negative value. The method automatically converts it to a positive amount and returns a warning.
-
WCA does not check for duplicate manual transactions through the data transfer process. It is the responsibility of the calling application not to send duplicate manual transactions.
History
The SubmitManualRefund methods are listed below:
Request Messages
-
SubmitManualRefundRequest_2011_12
-
SubmitManualRefundRequest_2009_04
-
SubmitManualRefundRequest_2008_07
-
SubmitManualRefundRequest_2006_05
-
SubmitManualRefundRequest
Response Messages
-
SubmitManualRefundResponse
SubmitManualRefund Request/Response Messages
The SubmitManualRefund
method requires the following request and response messages (input and
output data).
The table below includes the following request messages:
-
SubmitManualRefundRequest_2009_04
-
SubmitManualRefundRequest_2008_07
-
SubmitManualRefundRequest_2006_05
-
SubmitManualRefundRequest
The table below includes the following response message:
• SubmitManualRefundResponse_2009_04
Example of a SubmitManualRefund SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<SubmitManualRefund
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<submitManualRefundRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2009/04/" i:type="d4p3:SubmitManualRefund_2009_04">
<d4p1:AccountTypeCode>FSA</d4p1:AccountTypeCode>
<d4p1:CardNumber i:nil="true" />
<d4p1:CardholderId>Emp0</d4p1:CardholderId>
<d4p1:CardholderSocialSecurityNumber i:nil="true" />
<d4p1:DateOfServiceFrom>2009-03-10T15:22:00</d4p1:DateOfServiceFrom>
<d4p1:DateOfServiceTo>2009-03-10T15:23:00</d4p1:DateOfServiceTo>
<d4p1:DisplayDate>2009-03-10T15:22:00</d4p1:DisplayDate>
<d4p1:DisplayToCardholder>false</d4p1:DisplayToCardholder>
<d4p1:EmployerId>WWW5148</d4p1:EmployerId>
<d4p1:MerchantId>MerchId</d4p1:MerchantId>
<d4p1:MerchantName>MerchName</d4p1:MerchantName>
<d4p1:MerchantTypeCode>MerchCode</d4p1:MerchantTypeCode>
<d4p1:Note>Note</d4p1:Note>
<d4p1:PlanYearEndDate>2009-04-07T11:32:00</d4p1:PlanYearEndDate>
<d4p1:PlanYearStartDate>2009-04-07T11:32:00</d4p1:PlanYearStartDate>
<d4p1:RefundAmount>4.00</d4p1:RefundAmount>
<d4p1:TpaId>T00991</d4p1:TpaId>
<d4p1:TrackingNumber>TrackNumber</d4p1:TrackingNumber>
<PlanId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/05/">FSA1</Pl anId>
<CheckAcctEligibility
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</Ch eckAcctEligibility> <CheckEligibility
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</Ch eckEligibility>
<OverrideSuspendActivity
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">false</Ov errideSuspendActivity>
<ScCde
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/">scc</ScC de>
<d4p3:CrossOverClaim>false</d4p3:CrossOverClaim>
</submitManualRefundRequest>
</SubmitManualRefund>
</s:Body>
</s:Envelope>
Example of a SubmitManualRefund SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiWarningsHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBIWarnings xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">
<MBIWarningsHeader.MBIWarning>
<Code>101004</Code>
<Message>Your disbursable balance for FSA account is $4,912.44</Message>
</MBIWarningsHeader.MBIWarning>
</MBIWarnings>
</mbiWarningsHeader>
</s:Header>
<s:Body>
<SubmitManualRefundResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1"> <SubmitManualRefundResult i:type="b:SubmitManualRefundResponse_2009_04" xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2009/04/">
<b:ErrorCode>0</b:ErrorCode>
<b:TrackingNumber />
<b:TxnAmtOrig>4.00</b:TxnAmtOrig>
<b:TxnResponseList>
<b:ResponseAccount_2009_04>
<b:AcctTypeCde>FSA</b:AcctTypeCde>
<b:DisbBal>4912.44</b:DisbBal>
<b:TxnAmt>-4.00</b:TxnAmt>
</b:ResponseAccount_2009_04>
</b:TxnResponseList>
</SubmitManualRefundResult>
</SubmitManualRefundResponse>
</s:Body>
</s:Envelope>
Example client code
The following is an example of the client code (using a .NET proxy class for the service) used when a deposit to the SubmitManualRefund method.
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.SubmitManualRefundRequest_2006_05 request =
new localhost.SubmitManualRefundRequest_2006_05();
// Array for any warnings returned
localhost.MBIWarning[] mbiWarnings;
// set the parameters for the web method call
request.AccountTypeCode = "DCA";
request.DateOfServiceTo = new DateTime(2003,12,15);
request.DateOfServiceFrom = new DateTime(2003,12,15);
request.DisplayDate = new DateTime(2004,3,16);
request.DisplayToCardholder = true;
request.RefundAmount = 43M;
request.CardholderSocialSecurityNumber = "111111111";
request.EmployerId = "BCBOOOOOO";
request.Note = "This is a test";
request.TpaId = "TPA123";
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
proxy.SubmitManualRefund(request);
// Test if any warnings were returned
if(proxy.MBIWarningsHeaderValue!=null)
{
mbiWarnings = proxy.MBIWarningsHeaderValue.MBIWarnings;
for(int i=0; i < mbiWarnings.Length; i++)
{
// perform needed operations
}
}
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetDisbursableBalanceAffectingTxns
The purpose of this method is to allow you to keep your system as closely in synch as possible with the WCA application balances. The intent is to allow you to use your system balance for manual claim authorization. This method provides the most up to date disbursable balance affecting transaction data available in WCA at the time of the request. Any data posted to the Alegeus databases subsequent to the prior web service are not be available in your system until the next request. Therefore, this method does not guarantee your balances are up to date when authorizing a manual claim against your balance.
This method is used to retrieve a list of transactions that result in updating disbursable balance on the account within the last 30 days. Any request for data beyond 30 days should be done through an EDI EN export. This method provides for requesting a list of disbursable balance affecting transactions not only ‘per cardholder’ or ‘per employer’, but for the whole administrator population, filtering by the account type if necessary. The method returns records for the entire administrator in a single response (unless there are more than 100 records, in which case multiple requests are needed).
The disbursable balance affecting transactions are:
The following transactions are examples of non-disbursable balance affecting transactions:
-
Force posts with matching pre-auths
-
Transaction detail from a product partner (e.g., HSA custodian)
-
Denials or rejected transactions
-
Payroll contributions for prefunded plans
The recommended use of this web method is to request disbursable balance affecting transactions for your entire WCA instance multiple times throughout the day. You should use this method on your desired frequency with attention to the volume of transactions received within a given interval, such that this method is not over or under utilized. On an initial request, you specify 'settlement date’ – the last settlement date that was successfully received or any date from the last 30 days. If the last settlement sequence number that was successfully received is not available, then this field can be empty.
The response could contain a warning indicating that the request generated more than 100 records. The code, ‘100907’ and the description, 'Too many records. Please limit your query more' would be seen in the header in this case. This is similar to GetTransactionHistory and other web methods. The transactions are sorted by 'insert date/time'. You can provide more parameters and repeat the request or make the next request.
In the next request, specify the ‘settlement date from’ and ‘last settlement sequence number’ that appeared last in the previous response. This request ensures that you receive only those transactions (up to 100 transactions) since the last web method request received.
Note: The last record in the response does not necessarily contain the highest settlement date/sequence number as the transactions are sorted by insert date/time. Alegeus sends all transactions with an insert date/time greater than the one associated with the settlement date/sequence number provided in the request.
All transactions with the same insert date are sent in one response, regardless of the 100 transaction limit. This means transactions with the same insert date may form records 99 through 103 in a response.
History
The GetDisbursableBalanceAffectingTxns methods are listed
below:
Request Messages
-
GetDisbursableBalanceAffectingTxnsRequest_2011_12
-
GetDisbursableBalanceAffectingTxnsRequest
Response Messages
-
GetDisbursableBalanceAffectingTxnsResponse_2008_07
-
GetDisbursableBalanceAffectingTxnsResponse
GetDisbursableBalanceAffectingTxns Request/Response Messages
The
GetDisbursableBalanceAffectingTxns method requires the following request and
response messages (input and output data).
The table below includes the following request messages:
-
GetDisbursableBalanceAffectingTxnsRequest
The table below includes the following response messages:
-
GetDisbursableBalanceAffectingTxnsResponse_2008_07
-
GetDisbursableBalanceAffectingTxnsResponse
Example of a GetDisbursableBalanceAffectingTxns SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<GetDisbursableBalanceAffectingTxns
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1"> <getDisbursableBalanceAffectingTxnsRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2009/04/" i:type="d4p3:GetDisbursableBalanceAffectingTxns_2009_04">
<d4p1:AccountTypeCode />
<d4p1:CardNumber i:nil="true" />
<d4p1:CardholderId>Emp0</d4p1:CardholderId>
<d4p1:CardholderSocialSecurityNumber i:nil="true" />
<d4p1:EmployerId>WWW4533</d4p1:EmployerId>
<d4p1:LastSettlementSequenceNumber>1</d4p1:LastSettlementSequenceNumber>
<d4p1:SettlementDateFrom>20090311</d4p1:SettlementDateFrom>
<d4p1:SettlementDateTo>20090312</d4p1:SettlementDateTo>
<d4p1:TpaId>T00481</d4p1:TpaId>
<d4p1:TransactionCategory>All</d4p1:TransactionCategory>
<d4p1:VerboseMode>false</d4p1:VerboseMode>
</getDisbursableBalanceAffectingTxnsRequest>
</GetDisbursableBalanceAffectingTxns>
</s:Body>
</s:Envelope>
Example of a GetDisbursableBalanceAffectingTxns SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header />
<s:Body>
<GetDisbursableBalanceAffectingTxnsResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<GetDisbursableBalanceAffectingTxnsResult
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:GetDisbursableBalanceAffectingTxnsResponse i:type="b:GetDisbursableBalanceAffectingTxnsResponse_2009_04"
xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2009/04/">
<a:AccountTypeCode>FSA</a:AccountTypeCode>
<a:AvailBal>4478.3300</a:AvailBal>
<a:CardNumber>5543240040844503</a:CardNumber>
<a:CardholderId>Emp0</a:CardholderId>
<a:CardholderSocialSecurityNumber />
<a:DateOfServiceFrom>2009-03-11T00:00:00</a:DateOfServiceFrom>
<a:DateOfServiceTo>2009-03-11T00:00:00</a:DateOfServiceTo>
<a:DisbBal>4478.3300</a:DisbBal>
<a:DisbPtd>521.6700</a:DisbPtd>
<a:EmployerId>WWW4533</a:EmployerId>
<a:FamilyAvailBal>0.0000</a:FamilyAvailBal>
<a:FamilyDisbBal>0.0000</a:FamilyDisbBal>
<a:FamilyDisbPtd>0.0000</a:FamilyDisbPtd>
<a:FamilyPreauthBal>0.0000</a:FamilyPreauthBal>
<a:MerchantName />
<a:MerchantTypeCode>0000</a:MerchantTypeCode>
<a:Note />
<a:PlanYrEndDte>20091231</a:PlanYrEndDte>
<a:PlanYrStartDte>20080101</a:PlanYrStartDte>
<a:PreauthBal>0.0000</a:PreauthBal>
<a:SettlementDate>20090311</a:SettlementDate>
<a:SettlementSequenceNumber>30002129</a:SettlementSequenceNumber>
<a:TpaId>T00481</a:TpaId>
<a:TransactionAdjudicationStatus>ResolvedEmployeePay</a:TransactionAdjudicationStatus>
<a:TransactionAmount>25.0000</a:TransactionAmount>
<a:TransactionCode>ForcePost</a:TransactionCode>
<a:TransactionDate>2009-03-11T10:48:24</a:TransactionDate>
<a:TransactionDeniedAmount>0.0000</a:TransactionDeniedAmount>
<DeductibleAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">0.0000</ DeductibleAmount>
<b:DependentId />
<b:IsDepTxn>false</b:IsDepTxn>
</a:GetDisbursableBalanceAffectingTxnsResponse> <a:GetDisbursableBalanceAffectingTxnsResponse i:type="b:GetDisbursableBalanceAffectingTxnsResponse_2009_04"
xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2009/04/">
<a:AccountTypeCode>FSA</a:AccountTypeCode>
<a:AvailBal>4413.3300</a:AvailBal>
<a:CardNumber>5543240040844503</a:CardNumber>
<a:CardholderId>Emp0</a:CardholderId>
<a:CardholderSocialSecurityNumber />
<a:DateOfServiceFrom>2009-03-11T00:00:00</a:DateOfServiceFrom>
<a:DateOfServiceTo>2009-03-11T00:00:00</a:DateOfServiceTo>
<a:DisbBal>4413.3300</a:DisbBal>
<a:DisbPtd>586.6700</a:DisbPtd>
<a:EmployerId>WWW4533</a:EmployerId>
<a:FamilyAvailBal>0.0000</a:FamilyAvailBal>
<a:FamilyDisbBal>0.0000</a:FamilyDisbBal>
<a:FamilyDisbPtd>0.0000</a:FamilyDisbPtd>
<a:FamilyPreauthBal>0.0000</a:FamilyPreauthBal>
<a:MerchantName />
<a:MerchantTypeCode>0000</a:MerchantTypeCode>
<a:Note />
<a:PlanYrEndDte>20091231</a:PlanYrEndDte>
<a:PlanYrStartDte>20080101</a:PlanYrStartDte>
<a:PreauthBal>0.0000</a:PreauthBal>
<a:SettlementDate>20090311</a:SettlementDate>
<a:SettlementSequenceNumber>30002130</a:SettlementSequenceNumber>
<a:TpaId>T00481</a:TpaId>
<a:TransactionAdjudicationStatus>ResolvedEmployeePay</a:TransactionAdjudicationStatus>
<a:TransactionAmount>65.0000</a:TransactionAmount>
<a:TransactionCode>ForcePost</a:TransactionCode>
<a:TransactionDate>2009-03-11T10:48:25</a:TransactionDate>
<a:TransactionDeniedAmount>0.0000</a:TransactionDeniedAmount>
<DeductibleAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">0.0000</ DeductibleAmount>
<b:DependentId />
<b:IsDepTxn>false</b:IsDepTxn>
</a:GetDisbursableBalanceAffectingTxnsResponse>
</a:GetDisbursableBalanceAffectingTxnsResponse>
</GetDisbursableBalanceAffectingTxnsResult>
</GetDisbursableBalanceAffectingTxnsResponse>
</s:Body>
</s: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
GetDisbursableBalanceAffectingTxns method.
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.GetDisbursableBalanceAffectingTxnsRequest request =
new localhost.GetDisbursableBalanceAffectingTxnsRequest();
// create a new response object for the records that are returned
localhost.GetDisbursableBalanceAffectingTxnsResponse response;
// Array for any warnings returned
localhost.MBIWarning[] mbiWarnings;
// set the parameters for the web method call
request.CardNumber = 4238830020256851;
request.EmployerId = "PPP0110A";
request.SettlementDateFrom = new DateTime(2007,01,17);
request.SettlementDateTo = new DateTime(2007,01,17);
request.LastSettlementSequenceNumber = 30005990;
request.TpaId = "T00208"; request.TransactionCategory = "All";
request.VerboseMode = false;
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
response = proxy.SubmitManualRefund(request);
// Test if any warnings were returned
if(proxy.MBIWarningsHeaderValue!=null)
{
mbiWarnings = proxy.MBIWarningsHeaderValue.MBIWarnings;
for(int i=0; i < mbiWarnings.Length; i++)
{
// perform needed operations
}
}
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetDisbursableBalanceAffectingTotal
This
method is used to retrieve a total amount of balance affecting transactions
(as defined above) for the day, to be used for reconciliation.
This method is designed to be run once daily as a comparison against the detailed records received throughout the day and summarize, by the administrator, the net total amount of disbursable balance affecting transactions within a settlement day. The net total of transactions received through GetDisbursableBalanceAffectingTxns should match the total received in this method.
History
The GetDisbursableBalanceAffectingTotalRequest methods are listed below:
Request Messages
-
GetDisbursableBalanceAffectingTotalRequest_2011_12
-
GetDisbursableBalanceAffectingTotalRequest
Response Messages
-
GetDisbursableBalanceAffectingTotalResponse
GetDisbursableBalanceAffectingTotal Request/Response Messages
The GetDisbursableBalanceAffectingTotal method requires the following request and response messages (input and output data).
The table below includes the following request messages:
-
GetDisbursableBalanceAffectingTotalRequest
The table below includes the following response messages:
-
GetDisbursableBalanceAffectingTotalResponse
Example of a GetDisbursableBalanceAffectingTotal SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<GetDisbursableBalanceAffectingTotal
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<getDisbursableBalanceAffectingTotalRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2006/12/" i:type="d4p3:GetDisbursableBalanceAffectingTotal_2006_12"> <d4p1:AccountTypeCode>FSA</d4p1:AccountTypeCode>
<d4p1:CardNumber i:nil="true" />
<d4p1:CardholderId>Emp0</d4p1:CardholderId>
<d4p1:CardholderSocialSecurityNumber i:nil="true" />
<d4p1:EmployerId>WWW4533</d4p1:EmployerId>
<d4p1:SettlementDateFrom>20090311</d4p1:SettlementDateFrom>
<d4p1:SettlementDateTo>20090312</d4p1:SettlementDateTo>
<d4p1:TpaId>T00481</d4p1:TpaId>
<d4p1:TransactionCategory>All</d4p1:TransactionCategory>
<d4p1:VerboseMode>false</d4p1:VerboseMode>
</getDisbursableBalanceAffectingTotalRequest>
</GetDisbursableBalanceAffectingTotal>
</s:Body>
</s:Envelope>
Example of a GetDisbursableBalanceAffectingTotal SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header />
<s:Body>
<GetDisbursableBalanceAffectingTotalResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1"> <GetDisbursableBalanceAffectingTotalResult
i:type="b:GetDisbursableBalanceAffectingTotalResponse_2006_12" xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2006/12/">
<a:AccountTypeCode>FSA</a:AccountTypeCode>
<a:CardNumber>5543240040844503</a:CardNumber>
<a:CardholderId>Emp0</a:CardholderId>
<a:CardholderSocialSecurityNumber />
<a:EmployerId>WWW4533</a:EmployerId>
<a:LastSettlementSequenceNumber>30000348</a:LastSettlementSequenceNumber>
<a:SettlementDateFrom>20090311</a:SettlementDateFrom>
<a:SettlementDateTo>20090312</a:SettlementDateTo>
<a:TotalTransactionAmount>-12.0000</a:TotalTransactionAmount>
<a:TpaId>T00481</a:TpaId>
</GetDisbursableBalanceAffectingTotalResult>
</GetDisbursableBalanceAffectingTotalResponse>
</s:Body>
</s:Envelope>
Example client code
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.GetDisbursableBalanceAffectingTotalRequest request =
new localhost.GetDisbursableBalanceAffectingTotalRequest();
// create a new response object
localhost.GetDisbursableBalanceAffectingTotalResponse response;
// Array for any warnings returned
localhost.MBIWarning[] mbiWarnings;
// set the parameters for the web method call
request.AccountTypeCode = "DCA";
request.CardholderSocialSecurityNumber = "111111111";
request.DateOfServiceTo = new DateTime(2003,12,15);
request.DateOfServiceFrom = new DateTime(2003,12,15);
request.EmployerId = "BCBOOOOOO";
request.TpaId = "TPA123";
request.TransactionCategoryCode = "All";
request.VerboseMode = false;
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
response = proxy.GetDisbursableBalanceAffectingTotal(request);
// Test if any warnings were returned
if(proxy.MBIWarningsHeaderValue!=null)
{
mbiWarnings = proxy.MBIWarningsHeaderValue.MBIWarnings;
for(int i=0; i < mbiWarnings.Length; i++)
{
// perform needed operations
}
}
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
OtherDeposit
The
OtherDeposit method is used for special / other deposits to an employee’s
benefit account.
History
The OtherDeposit methods are listed below:
Request Messages
-
OtherDepositRequest
Response Messages
-
OtherDepositResponse
OtherDeposit Request/Response Messages
The OtherDeposit method
requires the following request and response messages (input and output
data).
The table below includes the following request messages:
• OtherDepositRequest
Response Message: Empty Message
Example of an OtherDeposit SOAP request message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">xuzwemv54lkupaujy4s sfnqa</MBISessionID> </mbiSessionHeader>
</s:Header>
<s:Body>
<OtherDeposit
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<otherDepositRequest
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2008/07/" i:type="d4p3:SpecialDeposit_2008_07">
<d4p3:AccountTypeCode>FSA</d4p3:AccountTypeCode>
<d4p3:AccountTypeEndDate>20091231</d4p3:AccountTypeEndDate>
<d4p3:AccountTypeStartDate>20080101</d4p3:AccountTypeStartDate>
<d4p3:DepositSubTypeId>KEllieWasHer</d4p3:DepositSubTypeId>
<d4p3:DepositType>OtherDeposit</d4p3:DepositType>
<d4p3:DisplayDate>2009-03-03T10:59:00</d4p3:DisplayDate>
<d4p3:DisplayToCardholder>true</d4p3:DisplayToCardholder>
<d4p3:EmployeeId>Emp0</d4p3:EmployeeId>
<d4p3:EmployeeSocialSecurityNumber i:nil="true" />
<d4p3:EmployerDepositAmount>22</d4p3:EmployerDepositAmount>
<d4p3:EmployerId>WWW4988</d4p3:EmployerId>
<d4p3:FamilyMemberId>FamilyMember</d4p3:FamilyMemberId>
<d4p3:Note>Note</d4p3:Note>
<d4p3:PlanId>PlanId</d4p3:PlanId>
<d4p3:TpaId>Tpa</d4p3:TpaId>
</otherDepositRequest>
</OtherDeposit>
</s:Body>
</s:Envelope>
Example of an OtherDeposit SOAP response message:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header />
<s:Body>
<OtherDepositResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<OtherDepositResult i:type="b:SpecialDepositResponse_2008_07"
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/" /> </OtherDepositResponse>
</s:Body>
</s:Envelope>
Example client code
try
{
// create new SOAP header for the user’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost. otherDepositRequest_2008_07 request =
new localhost. otherDepositRequest_2008_07();
// create a new response object
localhost.OtherDepositResult response;
// set the parameters for the web method call
request.AccountTypeCode = "FSA";
request.AccountTypeEndDate = "20081231";
request.AccountTypeStartDate = "20080101";
request.DisplayDate = new DateTime(1900,01,01);
request.DisplayToCardHolder = true;
request.EmployeeId = “Emp0”;
request.EmployerDepositAmount = 200;
request.EmployerId = “WWW27468”;
request.DepositSubTypeId = “0001”;
request.DepositType = localhost.DepositType.OtherDeposit
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
response = proxy.OtherDeposit(request);
}
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetTransactionByTN
This method is
used to retrieve transactional details for a given transaction, using the
Tracking Number field. This method should only be utilized if Tracking
Number is populate and unique for each transaction
History
The GetTransactionbyTN methods are listed below:
Request Messages
-
GetTransactionByTNRequest
Response Messages
-
GetTransactionByTNResponse
GetTransactionByTN Request/Response Messages
The GetTransactionByTN
method requires the following request and response messages (input and
output data).
The table below includes the following request messages:
-
GetTransactionByTNRequest
The table below includes the following response messages:
-
GetTransactionByTNResponse
Example of an GetTransactionByTN 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/WebS ervices/Contracts/Transaction/2009/04/V1/ITransactionService/GetTransactionByTN</Action>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">aiXXXXXXXXXXXXXz y</MBISessionID>
</mbiSessionHeader>
</s:Header>
<s:Body>
<GetTransactionByTN
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<request
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2012/03/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<d4p1:TpaId>T01213</d4p1:TpaId>
<d4p1:TrackingNumber>TEST1234</d4p1:TrackingNumber>
</request>
</GetTransactionByTN>
</s:Body>
</s:Envelope>
Example of an GetTransactionByTN SOAP response message:
xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://bensoft.metavante.com/WebS ervices/Contracts/Transaction/2009/04/V1/ITransactionService/GetTransactionByTN</Action>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID
xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">aiXXXXXXXXXXXXXz y</MBISessionID>
</mbiSessionHeader>
</s:Header>
<s:Body>
<GetTransactionByTN
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<request
xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2012/03/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<d4p1:TpaId>T01213</d4p1:TpaId>
<d4p1:TrackingNumber>TEST1234</d4p1:TrackingNumber>
</request>
</GetTransactionByTN>
</s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
<MessageId>urn:uuid:d1a09e58-4745-4acb-b8c4-28c8a17f54d1</MessageId>
</MBIMessageIdHeader>
</s:Header>
<s:Body>
<GetTransactionByTNResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<GetTransactionByTNResult
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2012/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:GetTransactionByTNResponse>
<AccountTypeCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">FSA</A ccountTypeCode>
<ApprovalCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">3051053 6</ApprovalCode>
<BalanceAfterTransaction
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">950.000
0</BalanceAfterTransaction>
<BalanceTimeTransaction
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">1000.00 00</BalanceTimeTransaction>
<CardNumber
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<CardholderName
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">Brown,
Bob</CardholderName>
<DeniedAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">0.0000</ DeniedAmount>
<DeniedReason
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" /> <DisplayDate xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">2012-
09-11T00:00:00</DisplayDate> <DisplayToEmployee
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">true</Di splayToEmployee>
<EmployeeName
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">Bob
Brown</EmployeeName>
<ErrorCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">0 - Approved</ErrorCode>
<ExceptionType
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">None</E xceptionType>
<ExpirationDate
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<Fee
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">0.0000</ Fee>
<FeePaidBy
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">None</F eePaidBy>
<MerchantCity
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<MerchantId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<MerchantName
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<MerchantState
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<MerchantTypeCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/"> </MerchantTypeCode>
<Notes
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<OriginalMerchantTypeCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<SequenceNumber
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">3001625 5</SequenceNumber>
<ServiceEndDate xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">2012-
09-11T00:00:00</ServiceEndDate>
<ServiceStartDate
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">201209-11T00:00:00</ServiceStartDate>
<SettlementDate
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">2012091 1</SettlementDate>
<Status
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">Purchas e</Status>
<StatusDateTime
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">190001-01T00:00:00</StatusDateTime>
<TerminalId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<TpaId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">T01213 </TpaId>
<TrackingNumber
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">TEST12 34</TrackingNumber>
<TransactionAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">50.0000 </TransactionAmount>
<TransactionDateTime
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">2012-
09-11T08:21:30</TransactionDateTime>
<TransactionType
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/">Admin - Purchase </TransactionType>
<UserUpdatingStatus
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2004/06/" />
<CheckNumber
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">1</CheckNumber>
<CheckReissue
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0</Chec kReissue>
<DentalAmount xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0</Dent alAmount>
<DentalAmountOriginal
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0</Dent alAmountOriginal> <HetAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0.0000</ HetAmount>
<HetAmountOriginal
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0.0000</ HetAmountOriginal> <OffsetAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0.0000</ OffsetAmount>
<PartialAuthIndicator
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">false</P artialAuthIndicator> <PartialAuthorized
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">false</P artialAuthorized>
<ReimbursementDate
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0</Reim bursementDate>
<ReimbursementMethod
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">DirectDe posit</ReimbursementMethod>
<RxAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0.0000</ RxAmount>
<RxAmountOriginal
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0.0000</ RxAmountOriginal>
<TotalAuthorizedAmountOriginal
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0.0000</ TotalAuthorizedAmountOriginal>
<TpsErrorCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">999</Tp sErrorCode>
<VisionAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0</Visio nAmount>
<VisionAmountOriginal xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2007/12/">0</Visio nAmountOriginal>
<BypassDeductibleIndicator
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">false</B ypassDeductibleIndicator> <DeductibleAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">0.0000</ DeductibleAmount>
<DepositSubTypeId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/" />
<DocumentTrackingNumbers i:nil="true"
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/" />
<FamilyRolloverDepositsPtd
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">0.0000</ FamilyRolloverDepositsPtd> <FundRolloverType
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">0</Fund RolloverType>
<ManualClaimNumber
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">2012091
11</ManualClaimNumber>
<ReduceByBalanceMax
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">false</R educeByBalanceMax>
<RolloverDepositsPtd
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/">0.0000</ RolloverDepositsPtd> <ServiceCategoryCode
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/" />
<ServiceCategoryCodeDescription
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2008/07/" />
<CrossOverClaim
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2009/04/">false</C rossOverClaim>
<EligDte
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/04/"> </EligDte>
<FlexAcctId
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/04/">0000000 382</FlexAcctId>
<PendedAmount
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/04/">0.0000</
PendedAmount>
<PendedReason
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/04/" />
<TermDte
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/04/"> </TermDte>
<PatientID
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<PayProviderFlag
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/">No</Pay ProviderFlag>
<ProviderAddress1
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<ProviderAddress2
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<ProviderCity
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<ProviderPhone
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<ProviderState
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<ProviderZip
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2010/10/" />
<CheckClearedDate
xmlns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2012/03/" />
</a:GetTransactionByTNResponse>
</GetTransactionByTNResult>
</GetTransactionByTNResponse>
</s:Body>
</s:Envelope>
GetRecentTransactions
This method
is used to retrieve a listing of up to the ten most recent transactions for
a specific employee or dependent.
History
The GetRecentTransactions methods are listed below:
Request Messages
-
GetRecentTransactionsRequest
Response Messages
-
GetRecentTransactionsResponse
GetRecentTransactions Request/Response Messages
The GetRecentTransactions method contains the following request and response messages (input and output data).
The table below includes the following request messages:
-
GetRecentTransactionsRequest
The table below includes the following response messages:
-
GetRecentTransactionsResponse
Example of an GetRecentTransactions SOAP request message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1" xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Transaction/Request/2015/06/">
<soapenv:Header>
<mbiSessionHeader>
<mbi:MBISessionID>bbb4cgbzzzzyv5lc4ho2x25</mbi:MBISessionID>
</mbiSessionHeader>
</soapenv:Header>
<soapenv:Body>
<v1:GetRecentTransactions>
<v1:request>
<ns:EmployeeId>123456789</ns:EmployeeId>
<ns:EmployerID>EMPLOYER1</ns:EmployerID>
<ns:NumberofRecentTransactions>9</ns:NumberofRecentTransactions>
<ns:TpaID>T00000</ns:TpaID>
</v1:request>
</v1:GetRecentTransactions>
</soapenv:Body>
</soapenv:Envelope>
Example of an GetRecentTransactions 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:0c48d75a-287c-40da-8aff-zzzzc098137f</MessageId>
</MBIMessageIdHeader>
</s:Header>
<s:Body>
<GetRecentTransactionsResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Transaction/2009/04/V1">
<GetRecentTransactionsResult
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Transaction/Response/2015/06/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:GetRecentTransactionsResponse>
<a:AccountTypeCode>ANY</a:AccountTypeCode>
<a:AccountTypeEndDate>20990316</a:AccountTypeEndDate>
<a:AccountTypeStartDate>20150316</a:AccountTypeStartDate>
<a:BypassDeductibleIndicator>false</a:BypassDeductibleIndicator>
<a:CardNumber/>
<a:CardholderId>123456789</a:CardholderId>
<a:CardholderSocialSecurityNumber/>
<a:CheckClearedDate/>
<a:DateOfServiceFrom>2015-03-16T00:00:00</a:DateOfServiceFrom>
<a:DateOfServiceTo>2015-03-16T00:00:00</a:DateOfServiceTo>
<a:DeductibleAmount>0.0000</a:DeductibleAmount>
<a:DentalAmount>0</a:DentalAmount>
<a:DentalAmountOriginal>0</a:DentalAmountOriginal>
<a:DependentId/>
<a:DepositSubTypeId/>
<a:DisplayDate>2015-03-16T00:00:00</a:DisplayDate>
<a:DisplayToCardholder>true</a:DisplayToCardholder>
<a:EligDte></a:EligDte>
<a:EligibleAmt>50.0000</a:EligibleAmt>
<a:EmpeAvailBal>0.0000</a:EmpeAvailBal>
<a:EmpeDisbBal>0.0000</a:EmpeDisbBal>
<a:EmpeDisbPtd>0.0000</a:EmpeDisbPtd>
<a:EmpePreauthBal>0.0000</a:EmpePreauthBal>
<a:ErrorCode>0 - Approved</a:ErrorCode>
<a:ExcludeFromEmployerFunding>false</a:ExcludeFromEmployerFunding>
<a:ExcludedAmount>0.0000</a:ExcludedAmount>
<a:ExcludedErrorCode>0</a:ExcludedErrorCode>
<a:ExcludedErrorDescription/>
<a:ExternalClaimNumber/>
<a:FamilyRolloverDepositsPtd>0.0000</a:FamilyRolloverDepositsPtd>
<a:FlexAcctId>0000000001</a:FlexAcctId>
<a:FundRolloverType>0</a:FundRolloverType>
<a:GLAccount>Contributions GL</a:GLAccount>
<a:HSACode>10</a:HSACode>
<a:HSACodeDescription>CY Normal Contribution</a:HSACodeDescription>
<a:HSAPostingDate></a:HSAPostingDate>
<a:HSAReasonForNonPostCode>0</a:HSAReasonForNonPostCode>
<a:HSAReasonForNonPostDescription/>
<a:HetAmount>0.0000</a:HetAmount>
<a:HetAmountOriginal>0.0000</a:HetAmountOriginal>
<a:HoldAmount>0.0000</a:HoldAmount>
<a:LowFundAmount>50.0000</a:LowFundAmount>
<a:ManualClaimNumber/>
<a:MerchantName/>
<a:MerchantTypeCode></a:MerchantTypeCode>
<a:Note/>
<a:OffsetAmount>0.0000</a:OffsetAmount>
<a:PartialAuthIndicator>false</a:PartialAuthIndicator>
<a:PartialAuthorized>false</a:PartialAuthorized>
<a:PayProviderFlag>No</a:PayProviderFlag>
<a:PinNetworkIndicator>false</a:PinNetworkIndicator>
<a:PostingType>Credit</a:PostingType>
<a:ProviderAddress1/>
<a:ProviderAddress2/>
<a:ProviderCity/>
<a:ProviderID/>
<a:ProviderState/
<a:ProviderZip/>
<a:ReduceByBalanceMax>false</a:ReduceByBalanceMax>
<a:RolloverDepositsPtd>0.0000</a:RolloverDepositsPtd>
<a:RxAmount>0.0000</a:RxAmount>
<a:RxAmountOriginal>0.0000</a:RxAmountOriginal>
<a:SequenceNumber>30002204</a:SequenceNumber>
<a:ServiceCategoryCode/>
<a:ServiceCategoryCodeDescription/>
<a:SettlementDate>20150316</a:SettlementDate>
<a:StatusCode>AAA1</a:StatusCode>
<a:TermDte></a:TermDte>
<a:TotalAuthorizedAmountOriginal>0.0000</a:TotalAuthorizedAmountOriginal>
<a:TpsErrorCode>999</a:TpsErrorCode>
<a:TrackingNumber/>
<a:TransactionAdjudicationStatus>Posted</a:TransactionAdjudicationStatus>
<a:TransactionAmount>50.0000</a:TransactionAmount>
<a:TransactionCode>AutoDeposit</a:TransactionCode>
<a:TransactionDate>2015-03-16T11:42:06.08</a:TransactionDate>
<a:TransactionDeniedAmount>0.0000</a:TransactionDeniedAmount>
<a:TransactionDesc>Funded Payroll Deposit - Employee</a:TransactionDesc>
<a:TransactionPendedAmount>0.0000</a:TransactionPendedAmount>
<a:TxnAdjudDesc>Approved</a:TxnAdjudDesc>
<a:VisionAmount>0</a:VisionAmount>
<a:VisionAmountOriginal>0</a:VisionAmountOriginal>
</a:GetRecentTransactionsResponse>
</GetRecentTransactionsResult>
</GetRecentTransactionsResponse>
</s:Body>
</s:Envelope>
Example client code
try
{
// create new SOAP header for the user’s current session id localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// create the proxy object for the service
localhost.TransactionService proxy = new localhost.TransactionService();
// create a new request object for the method’s parameters
localhost.GetRecentTransactionsRequest =
new localhost.GetRecentTransactions();
// create a new response object
localhost.GetRecentTransactionsResponse response;
// set the parameters for the web method call
request.EmployeeId = "123456789";
request.EmployerID = "EMPLOYER1";
request.NumberofRecentTransactions = "9";
request.TpaID = "T00000"
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
response = proxy. GetRecentTransactions(request);
}
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
SubmitParticipantClaim
History
The SubmitParticipantClaim methods are listed below:
Request Messages
• SubmitParticipantClaimRequest
SubmitParticipantClaim Request Messages
The SubmitParticipantClaim method contains the following request and response messages (input and output data).
The table below includes the following request messages:
• SubmitParticipantClaimRequest
SubmitDocument
This method is used to attach a document to a transaction
History
The SubmitDocument methods are listed below:
Request Messages
• SubmitDocumentRequest
SubmitDocument Request Messages
The SubmitDocument method contains
the following request and response messages (input and output data).
The table below includes the following request messages:
SubmitDocument
The table below includes the following response messages:
-
SubmitDocumentResponse
SubmitParticipantClaimDocument
History
The SubmitClaimDocument methods are listed below:
Request Messages
• SubmitParticipantClaimDocumentRequest
SubmitParticipantClaimDocument Request Messages
The
SubmitParticipantClaimDocument method contains the following request and
response messages (input and output data).
The table below includes the following request messages:
-
SubmitParticipantClaimDocumentRequest
The table below includes the following response messages:
-
SubmitParticipantClaimDocumentResponse
Copyright © 2024 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC