Search transactions and return full transaction records.
This method allows you to find transactions even if you have misplaced or can't remember the transaction's RefNum (a unique number assigned to each transaction by the gateway).
The following fields may be used to search the database and return transaction details:
TransID
BatchID
Type
Status
Response
AuthCode
AvsResult
CvcResult
Reason
ErrorCode
Created
CreateDate
CreateTime
Invoice
OrderID
PoNum
CustID
RecCustID
Description
Amount
Currency
RawAmount
Tax
Tip
Shipping
Discount
Subtotal
Cardholder
CCNum
CCNum4First
AvsStreet
AvsZip
User
Clerk
TranTerm
Rest_Table
Sources.Name
ServerIP
ClientIP
CheckNum
VCAccount
VCRouting
VCChecks.Effective
VCChecks.Settled
VCChecks.Processed
VCChecks.Returned
VCChecks.Banknote
Billing_FName
Billing_LName
Billing_Company
Billing_Street
Billing_Street2
Billing_City
Billing_State
Billing_Zip
Billing_Country
Billing_Phone
Email
Fax
Website
Shipping_FName
Shipping_LName
Shipping_Company
Shipping_Street
Shipping_Street2
Shipping_City
Shipping_State
Shipping_Zip
Shipping_Country
Shipping_Phone
See also searchTransactionsCustom and searchTransactionsCount
| Type | Name | Description |
| ueSecurityToken | Token | Merchant security token: used to identify merchant and validate transaction. |
| SearchParam | Search | Array of search parameters (SearchParam objects) available. |
| 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 | Record number to start returning from (ie if 1,000 were found and you only want to receive the last 200 you would set Start=800 and Limit=200) |
| integer | Limit | Maximum number of transactions to return in result set. |
| string | Sort | Comma separated list of fields to sort by. |
| TransactionSearchResult | Returns the full transaction records for all transactions matching the specified search parameters. |
For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.
<?php
try {
// Create search parameter list
$search=array(
array(
'Field'=>'amount',
'Type'=>'eq',
'Value'=>'4.00'),
array(
'Field'=>'created',
'Type'=>'gt',
'Value'=>'2007-03-21'),
array(
'Field'=>'created',
'Type'=>'lt',
'Value'=>'2007-03-22'),
array(
'Field'=>'response',
'Type'=>'eq',
'Value'=>'A')
);
$start=0;
$limit=100;
$matchall=true;
$sort='created';
$res=$client->searchTransactions($token,$search,$matchall,$start,$limit,$sort);
print_r($res);
}
catch(SoapFault $e) {
echo $client->__getLastResponse();
die("Search Transaction Failed :".$e->getMessage());
}
?>
<?php
include './nusoap.php';
// Create Soap Client
$s=new soapclient("./usaepay.wsdl",'wsdl');
$tran=$s->getProxy();
// Source Key Setting
$sourcekey='yQbOFkjD8wwlkZ3AhY248k3Lc9PH1l14';
$pin='1234';
// Prep source key
$seed=mktime() . rand();
$tmp=$sourcekey . $seed . $pin;
$hash=sha1($tmp);
$token=array('SourceKey'=>$sourcekey, 'PinHash'=>array('Type'=>'sha1', 'Seed'=>$seed,'HashValue'=>$hash));
// Prep Request data
$search=array(
array('Field'=>'amount', 'Type'=>'gt','Value'=>'5.00'),
array('Field'=>'created', 'Type'=>'gt', 'Value'=>'2005-01-01'),
array('Field'=>'response', 'Type'=>'eq', 'Value'=>'A')
);
$start=0;
$limit=10;
$matchall=true;
$sort='created';
$res=$tran->searchTransactions($token,$search,$matchall,$start,$limit,$sort);
if(!$err=$tran->getError()) {
print_r($res);
} else {
echo "Error: $err\n";
echo $tran->request;
}
Dim client As usaepay.usaepayService = New usaepay.usaepayService
Dim token As usaepay.ueSecurityToken
token = Me.CreateToken("982lz9VsLm87MA54Sv8E582h8OZMArL6", "443311")
Dim MatchAll As Boolean
MatchAll = False
Dim searchParams(1) As usaepay.SearchParam
searchParams(0) = New usaepay.SearchParam
searchParams(0).Field = "Created"
searchParams(0).Type = "eq"
searchParams(0).Value = "2009-02-19"
Dim SearchResults As usaepay.TransactionSearchResult = New usaepay.TransactionSearchResult
SearchResults = client.searchTransactions(token, searchParams, MatchAll, 0, 1000, "created")
MsgBox(SearchResults.TransactionsMatched)
NOTE: this example has not been tested and is provided as is
<cfscript>
Start = 0;
Limit = 10;
MatchAll=1;
Sort='created';
Search=ArrayNew(1);
Search[1]=structnew();
Search[1].Field='created';
Search[1].Type='gt';
Search[1].Value='2006-09-01';
ws = createObject("webservice", "https://www.usaepay.com/soap/gate/3213EA2A/usaepay.wsdl");
Output = ws.searchTransactions(Token, Search, MatchAll, Start, Limit, Sort);
</cfscript>
<?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:searchTransactions>
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">34108e1b91894ab1da5ecdc213341c6d757217c1</HashValue>
<Seed xsi:type="xsd:string">11936961311067412713</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
<Search SOAP-ENC:arrayType="ns1:SearchParam[1]" xsi:type="ns1:SearchParamArray">
<item xsi:type="ns1:SearchParam">
<Field xsi:type="xsd:string">amount</Field>
<Type xsi:type="xsd:string">eq</Type>
<Value xsi:type="xsd:string">29.00</Value>
</item>
</Search>
<MatchAll xsi:type="xsd:boolean">true</MatchAll>
<Start xsi:type="xsd:integer">0</Start>
<Limit xsi:type="xsd:integer">10</Limit>
<Sort xsi:type="xsd:string">created</Sort>
</ns1:searchTransactions>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
| Version | Change |
| 1.2 | Added Sort Parameter |
| 1.1 | Soap 1.1 Release |