searchBatches

Search previously settled batches.

Description

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.”

Syntax

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

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and validate transaction.
SearchParam	Search	Array of search parameters
boolean	MatchAll	If set to “true,” only results matching all search criteria will be returned, if set to “false,” results matching any of the search criteria will be returned.
integer	Start	Index to start returning batches from.
integer	Limit	Max number of batches to return in result set.
string	Sort	Field name to sort the results by

Return Value

BatchSearchResult

Returns the result of the batch search based on the search parameters set.

Examples

PHP

<?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());

}

Java

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());

}

.NET VB

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 eBizCharge.SearchParam

search(0) = New eBizCharge.SearchParam

search(0).Field = "closed"

search(0).Type = "gt"

search(0).Value = "2010-08-05"

Dim result As eBizCharge.BatchSearchResult = New eBizCharge.BatchSearchResult

result = client.searchBatches(token, search, matchAll, start, limit, sort)

MsgBox(result.BatchesMatched)

.NET C#

Boolean matchAll;

matchAll = true;

string start = "0";

string limit = "10";

string sort = "closed";

eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];

search[0] = new eBizCharge.SearchParam();

search[0].Field = "Closed";

search[0].Type = "gt";

search[0].Value = "2010-08-05";

eBizCharge.BatchSearchResult result = new eBizCharge.BatchSearchResult();

try

{

result = client.searchBatches(token, search, matchAll, start, limit, sort);

MessageBox.Show(string.Concat(result.BatchesMatched));

}

catch (Exception err)

{

MessageBox.Show(err.Message);

}

XML

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:ns1="urn:eBizCharge" 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>

</PinHash>

<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>

</Token>

<Field xsi:type="xsd:string">closed</Field>

</item>

</Search>

<Sort xsi:type="xsd:string">closed</Sort>

</ns1:searchBatches>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>