SOAP API Ref | Admin | Adjudication

Adjudication API | Administrative - SOAP

The Adjudication Service provides clients adjudication functionality such as updating a transaction’s status, creating a recurring expense, and viewing a transaction’s history.

Service Web Methods

The following is a list of methods that are provided by the Adjudication Service.

GetRecurringExpense – returns a list of recurring expenses that where created from a given transaction.
GetTransactionInfo – returns information about a given transaction.
CreateRecurringExpense – used to create a recurring expense using an existing transaction as a template.
UpdateTransactionStatus – used to update a transaction’s status.

Service Assumptions and Business Rules

The Adjudication Service makes the following assumptions and 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 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.

____________________________________________________________________________________________________________________________________________________________

GetRecurringExpenses

This method is used to get a list of all the recurring expenses that were created from a given transaction. It can be used to verify the results of the CreateRecurringExpense method.

History
The GetRecurringExpenses methods are listed below:

Request Message

GetRecurringExpensesRequest

Response Message

GetRecurringExpensesResponse

GetRecurringExpenses Request/Response Messages
The GetRecurringExpenses method require thes following request and response messages (input and output data). The table below includes the following request message:

GetRecurringExpensesRequest

The table below includes the following response message:

GetRecurringExpensesResponse

Example of a GetRecurringExpenses 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>sasozey43mknxx55kvdzsq55</MBISessionID> 
</MBISessionHeader>
</soap:Header>
<soap:Body> <GetRecurringExpenses 
xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Request/2004/06/">
<getRecurringExpensesRequest>
<SettlementDate>20030316</SettlementDate> 
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<TpaId>TPA123</TpaId> 
<VerboseMode>false</VerboseMode> 
</getRecurringExpensesRequest>
</GetRecurringExpenses>
</soap:Body>
</soap:Envelope>

Example of a GetRecurringExpenses 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/">
<MessageId>ac4c1bc6-0ec4-4e32-a07e-dc715e79540d</MessageId> 
</MBIMessageIdHeader>
</soap:Header>
<soap:Body>
<GetRecurringExpensesResponse
xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Response/2004/06/"> <GetRecurringExpensesResult>
<GetRecurringExpensesResponse>
<CardTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">MasterCard</CardTypeCode> 
<EffectiveDate>20030101</EffectiveDate> 
<ExpenseAmount>54.5</ExpenseAmount> 
<ExpireDate>20041231</ExpireDate> 
<Mtc>8211</Mtc> 
<MtcDescription>Elementary and Secondary Schools</MtcDescription> 
<SettlementDate>20030316</SettlementDate> 
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<TpaId>TPA123</TpaId> 
</GetRecurringExpensesResponse>
<GetRecurringExpensesResponse>
<CardTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">MasterCard</CardTypeCode> 
<EffectiveDate>20030130</EffectiveDate> 
<ExpenseAmount>54.5</ExpenseAmount> 
<ExpireDate>20041231</ExpireDate> 
<Mtc>8211</Mtc> 
<MtcDescription>Elementary and Secondary Schools</MtcDescription> 
<SettlementDate>20030316</SettlementDate> 
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<TpaId>TPA123</TpaId> 
</GetRecurringExpensesResponse>
</GetRecurringExpensesResult>
</GetRecurringExpensesResponse>
           </soap:Body>
          </soap:Envelope>

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

try {
 // Create the session SOAP header in order to pass the service   // the client’s current session ID.
   localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
      // Create proxy object for the Adjudication service
   localhost.AdjudicationService proxy = new localhost.AdjudicationService();
            // request message for method call (input parameters)  localhost.GetRecurringExpensesRequest request = new 
localhost.GetRecurringExpensesRequest();
 // Declare reference variable for receiving the returned values, // in this case the response will contain the recurring expense information.  localhost.GetRecurringExpensesResponse[] responses;
 // Set the input parameters  request.SettlementDate = "20030316";  request.SettlementSequenceNumber = 28;
            request.TpaId = "TPA123";
session ID returned from login method    sh.MBISessionID = _sessionID;
        proxy.MBISessionHeaderValue = sh;
 // Call the Get Recurring Expenses method  responses = proxy.GetRecurringExpenses(request);
          if(responses != null)
            {
                   for(int i=0; i < responses.Length; i++)
                        {
                       // perform needed operations                
                        }
            }
            else
            {
                   MessageBox.Show("Records not found"); 
            }
}
catch(SoapException se)
{
        // perform needed operations
}
catch(Exception ex)
{
         // perform needed operations
}

____________________________________________________________________________________________________________________________________________________________

GetTransactionInfo

This method is used to provide information about the current status of a given transaction. It can be used to check the status of a transaction before or after trying to update it.

History
The GetTransactionInfo methods are listed below:

Request Message

GetTransactionInfoRequest

Response Message

GetTransactionInfoResponse_2010_10
GetTransactionInfoResponse_2008_07
GetTransactionInfoResponse_2007_12
GetTransactionInfoResponse

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

GetTransactionInfoRequest

The table below includes the following response message:

GetTransactionInfoResponse_2013_02
GetTransactionInfoResponse_2008_07
GetTransactionInfoResponse_2007_12
GetTransactionInfoResponse

Example of a GetTransactionInfo 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>ocjcbj55gitivgmbh33pcm55</MBISessionID> 
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetTransactionInfo   xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Request/2004/06/"> <getTransactionInfoRequest>
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<TpaId>TPA123</TpaId> 
<SettlementDate>20030316</SettlementDate> 
<VerboseMode>20030316</VerboseMode>
</getTransactionInfoRequest>
</GetTransactionInfo>
</soap:Body>
</soap:Envelope>

Example of a GetTransactionInfo 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/">
<MessageId>21ee3e55-cd55-4ea9-9d6f-392b3e80d3ef</MessageId> 
</MBIMessageIdHeader>
</soap:Header>
<soap:Body>
<GetTransactionInfoResponse
 xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Response/2004/06/"> <GetTransactionInfoResult>
<AccountTypeCode>DCA</AccountTypeCode> 
<CheckNumber>-1</CheckNumber> 
<DisplayDate>2003-02-07T00:00:00.0000000-05:00</DisplayDate>
<MerchantName /> 
<ServiceEndDate>2003-02-07T00:00:00.0000000-05:00</ServiceEndDate> 
<ServiceStartDate>2003-02-07T00:00:00.0000000-05:00</ServiceStartDate> 
<SettlementDate>20030316</SettlementDate> 
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<StatusCode>AUP2</StatusCode> 
<TransactionAdjudicationStatus                               
  xmlns="http://www.medibank.com/MBIWebServices/Enums/">Pending</TransactionAdjudicationStatus> 
<TransactionAmount>54.5</TransactionAmount> 
<TransactionDate>2003-03-16T00:38:15.0000000-05:00</TransactionDate> 
<TpaId>TPA123</TpaId> 
</GetTransactionInfoResult>
</GetTransactionInfoResponse>
</soap:Body>
</soap:Envelope>

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

try {
// Create the session SOAP header in order to pass the service   // the client’s current session ID.  localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// Create proxy object for the Adjudication service
   localhost.AdjudicationService proxy = new localhost.AdjudicationService();
            // request message for method call (input parameters)  localhost.GetTransactionInfoRequest request = new 
                                                                   localhost.GetTransactionInfoRequest();
// Declare reference variable for receiving the returned values,
// in this case the response will contain the transaction information.  localhost.GetTransactionInfoResponse response;
// Set the input parameters  request.SettlementDate = "20030316";  request.SettlementSequenceNumber = 28;  request.TpaId = "TPA123";
// session ID returned from login method
 sh.MBISessionID = _sessionID;  proxy.MBISessionHeaderValue = sh;
        // Call the Get transaction info method
      response = proxy.GetTransactionInfo(request); 
          if(response != null)
            {
                    // perform needed operations
}
            else
            {
                   MessageBox.Show("Records not found"); 
            }
}
catch(SoapException se)
{
        // perform needed operations
}
catch(Exception ex)
{
        // perform needed operations
}

____________________________________________________________________________________________________________________________________________________________

CreateRecurringExpense

This method is used to create a recurring expense using an existing transaction as a template. This transaction must be a force post.

History
The CreateRecurringExpense methods are listed below:

Request Message

CreateRecurringExpenseRequest

Response Message

CreateRecurringExpenseResponse

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

CreateRecurringExpenseRequest

Response Message: Empty Message

Example of a CreateRecurringExpense 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>5z0e0m45mdival55jchz0cy1</MBISessionID> 
</MBISessionHeader>
</soap:Header>
<soap:Body>
<CreateRecurringExpense
xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Request/2004/06/"> <createRecurringExpenseRequest>
<EffectiveFrom>2003-01-30</EffectiveFrom> 
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<TpaId>TPA123</TpaId> 
<SettlementDate>20030316</SettlementDate> 
</createRecurringExpenseRequest>
</CreateRecurringExpense>
</soap:Body>
 </soap:Envelope>

Example of a CreateRecurringExpense 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>
<CreateRecurringExpenseResponse 
xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Response/2004/06/"> <CreateRecurringExpenseResult /> 
</CreateRecurringExpenseResponse>
</soap:Body>
</soap:Envelope>

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

try {
// Create the session SOAP header in order to pass the service   // the client’s current session ID.  localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// Create proxy object for the Adjudication service  localhost.AdjudicationService proxy = new localhost.AdjudicationService();
            // request message for method call (input parameters)                    localhost.CreateRecurringExpenseRequest request = new
localhost.CreateRecurringExpenseRequest();
         // Set the input parameters                                     
 request.SettlementDate = "20030316";  request.SettlementSequenceNumber = 28;  request.TpaId = "TPA123";
      request.EffectiveFrom = new DateTime(2003,1,30);
// session ID returned from login method
        sh.MBISessionID = _sessionID;
        proxy.MBISessionHeaderValue = sh;
// Call the CreateRecurringExpense
      proxy.CreateRecurringExpense(request); 
        MessageBox.Show("Finished.");                            
}
catch(SoapException se)
{
            // perform needed operations
}
catch(Exception ex)
{
        // perform needed operations
}

____________________________________________________________________________________________________________________________________________________________

UpdateTransactionStatus

Adjudication is normally performed within the administrator’s application. If desired, the administrator can utilize the UpdateTransactionStatus web method to update a transaction’s status.

History
The UpdateTransactionStatus methods are listed below:

Request Message

UpdateTransactionStatusRequest

Response Message

UpdateTransactionStatusResponse

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

UpdateTransactionStatusRequest

Response Message: Empty Message

Example of a UpdateTransactionStatus request message

<?xml version="1.0" encoding="utf-8" ?> 
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:xsi="ttp://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>bfkkazi45wlulkijuw1grb55</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<UpdateTransactionStatus
xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Request/2004/06/"> <updateTransactionStatusRequest>
<SettlementSequenceNumber>28</SettlementSequenceNumber> 
<TransactionAdjudicationStatus                                        
            xmlns="http://www.medibank.com/MBIWebServices/Enums/">Ineligible</TransactionAdjudicationStatus>  <TpaId>TPA123</TpaId> 
<SettlementDate>20030316</SettlementDate> 
</updateTransactionStatusRequest>
</UpdateTransactionStatus>
</soap:Body>
</soap:Envelope>

Example of a UpdateTransactionStatus 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/">
<MessageId>e075a918-5da2-4e32-8d26-2cd43f532c36</MessageId> 
</MBIMessageIdHeader>
</soap:Header>
<soap:Body>
<UpdateTransactionStatusResponse 
            xmlns="http://www.medibank.com/MBIWebServices/Transactions/Messages/Adjudication/Response/2004/06/">  <UpdateTransactionStatusResult /> 
</UpdateTransactionStatusResponse>
</soap:Body>
</soap:Envelope>

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

try {
// Create the session SOAP header in order to pass the service   // the client’s current session ID. 
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// Create proxy object for the Adjudication service
   localhost.AdjudicationService proxy = new localhost.AdjudicationService();
            // request message for method call (input parameters)  localhost.UpdateTransactionStatusRequest request = new 
                                                                  localhost.UpdateTransactionStatusRequest();
         // Set the input parameters                                     
 request.SettlementDate = "20030316";  request.SettlementSequenceNumber = 28;  request.TpaId = "TPA123";
request.TransactionAdjudicationStatus = 
                                          localhost.TransactionAdjudStatus.Ineligible;
// session ID returned from login method
 sh.MBISessionID = _sessionID;  proxy.MBISessionHeaderValue = sh;
// Call the UpdateTransactionStatus method  proxy.UpdateTransactionStatus(request); 
 
        MessageBox.Show("Finished");                                 
}
catch(SoapException se)
{
         // perform needed operations
}
catch(Exception ex)
{
        // perform needed operations}

Adjudication API | Administrative - SOAP

GetRecurringExpenses

GetTransactionInfo

CreateRecurringExpense

UpdateTransactionStatus

Transaction Statuses