Search previously settled batches.

Use this method to search batches that you have already settled. This method allows the following fields to be used in the search:

Sequence - Platform reference number. Opened - Date batch was opened. Closed - Date batch was closed.

Use as many or as few search terms as you like. With MatchAll set to “true,” all terms must match to return a result. If the search does not yield the desired result, try broadening your search by eliminating terms, or change MatchAll to “false.”

See also getBatchStatus, closeBatch, getBatchTransactions

BatchSearchResult searchBatches ( ueSecurityToken Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string Sort)

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php
 
try {
 
// make sure you have prepared data to search on
 
  $search=array(
    array(
      'Field'=>'closed', 
      'Type'=>'gt',
      'Value'=>'2007-04-01'),
    );
  $start=0;
  $limit=100;
  $matchall=true;
  $sort='closed';
 
  $res=$client->searchBatches($token,$search,$matchall,$start,$limit,$sort);
 
  print_r($res);
} 
 
catch (SoapFault $e) {
 
  echo $client->__getLastRequest();
  echo $client->__getLastResponse();
  die("Search batches failed failed :" .$e->getMessage());
 
}
 
?> 

This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
 
SearchParamArray searchParams = new SearchParamArray();
searchParams.add(new SearchParam("Sequence","eq", "123456"));
BigInteger start = new BigInteger("0");
BigInteger limit = new BigInteger("9999999");
 
 
BatchSearchResult BatchResult = new BatchSearchResult();
BatchResult = client.searchBatches(token, searchParams, true, start, limit, "Sequence");
 
 
  System.out.println(BatchResult.getBatchesMatched());
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());
}

Dim matchAll As Boolean
        matchAll = True
        Dim start As String
        Dim limit As String
        Dim sort As String
        start = "0"
        limit = "10"
        sort = "closed"
 
        Dim search(0 To 1) As usaepay.SearchParam
        search(0) = New usaepay.SearchParam
        search(0).Field = "closed"
        search(0).Type = "gt"
        search(0).Value = "2010-08-05"
 
        Dim result As usaepay.BatchSearchResult = New usaepay.BatchSearchResult
        result = client.searchBatches(token, search, matchAll, start, limit, sort)
        MsgBox(result.BatchesMatched)

For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the C Sharp .Net Soap How-to.

Boolean matchAll;
            matchAll = true;
            string start = "0";
            string limit = "10";
            string sort = "closed";
 
            usaepay.SearchParam[] search = new usaepay.SearchParam[2];
            search[0] = new usaepay.SearchParam();
 
            search[0].Field = "Closed";
            search[0].Type = "gt";
            search[0].Value = "2010-08-05";
 
            usaepay.BatchSearchResult result = new usaepay.BatchSearchResult();
 
            try
            {
                result = client.searchBatches(token, search, matchAll, start, limit, sort);
 
                MessageBox.Show(string.Concat(result.BatchesMatched));
 
            }
 
 
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
            }

Request:

<?xml version="1.0" encoding="UTF-8"?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="urn:usaepay"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:searchBatches>
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">123.123.123.123</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">e64020497009e46cec2da75a7b92d749df748521</HashValue>
<Seed xsi:type="xsd:string">1278362198-test</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
<Search SOAP-ENC:arrayType="ns1:SearchParam[1]" xsi:type="ns1:SearchParamArray">
<item xsi:type="ns1:SearchParam">
<Field xsi:type="xsd:string">BatchRefNum</Field>
<Type xsi:type="xsd:string">eq</Type>
<Value xsi:type="xsd:string">198907</Value>
</item>
</Search>
<MatchAll xsi:type="xsd:boolean">true</MatchAll>
<Start xsi:type="xsd:integer">0</Start>
<Limit xsi:type="xsd:integer">100</Limit>
<Sort xsi:type="xsd:string">closed</Sort>
</ns1:searchBatches>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>