SearchTransactions
Description
The SearchTransactions method retrieves all transactions matching the search filter criteria.
Syntax
TransactionSearchResult SearchTransactions(SecurityToken securityToken, SearchFilter[] filters, boolean matchAll, boolean countOnly, string start, string limit, string sort)
Arguments
Type | Name | Description | |
|---|---|---|---|
securityToken | R | A unique token that is used to identify a merchant and authenticate the API request. | |
filters | R | Filters transaction objects based on one or more field names, comparison operators, and field values. See supported search parameters below. | |
boolean | matchAll | R | Whether results must match all search filters. Possible Values
|
boolean | countOnly | R | Whether to only return transaction counts. Possible Values
|
string | start | O | Index of the first object to return in the array. Note: Default value is 0. Must be ≥ 0. |
string | limit | O | Maximum number of objects to return. Note: Default value is 1. Must be > 0. |
string | sort | O | Comma separated list of fields to sort by. Possible Values
|
Supported Search Parameters
| Parameter | Description | Example of Use |
|---|---|---|
| Amount | Filters by the transaction amount. | |
| AuthCode | Filters by the transaction authorization code. | |
| AvsResult | Filters by the AVS result code. | |
| AvsStreet | Filters by the AVS street address. | |
| AvsZip | Filters by the AVS ZIP code. | |
| BatchID | Filters by the batch ID. | |
| Billing_City | Filters by the billing address city. | |
| Billing_Company | Filters by the the billing address company. | |
| Billing_Country | Filters by the billing address country. | |
| Billing_FName | Filters by the first name associated with the billing address. | |
| Billing_LName | Filters by the last name associated with the billing address. | |
| Billing_Phone | Filters by the phone number associated with the billing address. | |
| Billing_State | Filters by the state associated with the billing address. | |
| Billing_Street | Filters by the billing street address. | |
| Billing_Street2 | Filters by the billing address street line 2. | |
| Billing_Zip | Filters by the billing ZIP code. | |
| Cardholder | Filters by the name of the cardholder. | |
| CCNum | Filters by credit card number. | |
| CheckNum | Filters by the check number. | |
| Clerk | Filters by the clerk associated with the transaction. | |
| ClientIP | Filters by the client's IP address. | |
| Created | Filters by the date and time the transaction was created. | |
| CustID | Filters by the customer ID. | |
| Currency | Filters by the currency type. | |
| CvcResult | Filters by the card code result code. Reference the CardCodeResultCode field in the TransactionResponse object for possible values. | |
| Description | Filters by the description. | |
| Discount | Filters by the discount applied to the transaction. | |
| Filters by the billing email address. | | |
| ErrorCode | Filters by the error code. | |
| Invoice | Filters by the invoice ID. | |
| OrderId | Filters by the order ID. | |
| PoNum | Filters by the purchase order number. | |
| RawAmount | Filters by the raw amount. | |
| Reason | Filters by the reason for an error. | |
| RecCustID | Filters by the customer number (CustNum). | |
| Response | Filters by the result code. Reference the ResultCode field in the TransactionResponse object for possible values. | |
| Rest_Table | Filters by the REST API table. | |
| ServerIP | Filters by the server IP address. | |
| Shipping | Filters by the cost for shipping. | |
| Shipping_City | Filters by the shipping address city. | |
| Shipping_Company | Filters by the shipping address company. | |
| Shipping_Country | Filters by the shipping address country. | |
| Shipping_FName | Filters by the first name associated with the shipping address. | |
| Shipping_LName | Filters by the last name associated with the shipping address. | |
| Shipping_Phone | Filters by the shipping address phone number. | |
| Shipping_State | Filters by the shipping address state. | |
| Shipping_Street | Filters by the shipping street address. | |
| Shipping_Street2 | Filters by the shipping address street line 2. | |
| Shipping_Zip | Filters by the shipping address ZIP code. | |
| Sources.Name | Filters by the name of the transaction source. | |
| Status | Filters by the status code. Reference the StatusCode field in the TransactionResponse object for possible values. | |
| Subtotal | Filters by the subtotal. | |
| Tax | Filters by the tax amount. | |
| Tip | Filters by the tip amount. | |
| TransID | Filters by the transaction ID. | |
| TranTerm | Filters by the terminal associated with the transaction. | |
| Type | Filters by the transaction type. Reference the TransactionType field in the TransactionObject object for possible values. | |
| User | Filters by the user. | |
| VCAccount | Filters by the virtual card account number. | |
| VCChecks.Banknote | Filters by the banknote. | |
| VCChecks.Effective | Filters by the effective date of the ACH transaction. | |
| VCChecks.Processed | Filters by the date the ACH transaction is processed. | |
| VCChecks.Returned | Filters by the ACH returned data. | |
| VCChecks.Settled | Filters by the date the ACH transaction is settled. | |
| VCRouting | Filters by the ACH routing number. | |
Return Value
| Type | Description |
|---|---|
| TransactionSearchResult | On success, returns all transactions matching the search filters. Otherwise, a fault is returned. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:SearchTransactions>
<ebiz:securityToken>
<ebiz:SecurityId>***********4621-b899***********</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:filters>
<!--One or more repetitions:-->
<ebiz:SearchFilter>
<ebiz:FieldName>CustomerId</ebiz:FieldName>
<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>
<ebiz:FieldValue>Cbs0001</ebiz:FieldValue>
</ebiz:SearchFilter>
<ebiz:SearchFilter>
<ebiz:FieldName>Amount</ebiz:FieldName>
<ebiz:ComparisonOperator>lt</ebiz:ComparisonOperator>
<ebiz:FieldValue>100</ebiz:FieldValue>
</ebiz:SearchFilter>
</ebiz:filters>
<ebiz:matchAll>true</ebiz:matchAll>
<ebiz:countOnly>false</ebiz:countOnly>
<ebiz:start/>
<ebiz:limit/>
<ebiz:sort/>
</ebiz:SearchTransactions>
</soapenv:Body>
</soapenv:Envelope>var client = new IeBizServiceClient();
SecurityToken securityToken = new SecurityToken
{
SecurityId = "***********4684-4856***********",
UserId = "",
Password = ""
};
bool matchAll = true;
bool countOnly = false;
SearchFilter[] searchFilters = new SearchFilter[]
{
new SearchFilter()
{
FieldName = "created",
ComparisonOperator = "gt",
FieldValue = "2026-01-28"
}
};
var result = client.SearchTransactions(securityToken, searchFilters, matchAll, countOnly, "0", "1000", "");
Console.WriteLine($"Matching Transactions: {result.TransactionsMatched}");function searchTransactions()
{
$client = new SoapClient('End point URL');
$securityToken = array(
'SecurityId' => '***********4757-4567***********',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
$SearchFilter = array(
'FieldName' => 'CustomerId',
'ComparisonOperator' => 'eq',
'FieldValue' => 1
);
$SearchTransactions = $client->SearchTransactions(
array(
'securityToken' => $securityToken,
'matchAll' => 1,
'countOnly' => 0,
'start' => 0,
'limit' => 1000,
'sort' => 'DateTime',
'filters' => $SearchFilter
))
;
$searchTransactionsResult = $SearchTransactions->SearchTransactionsResult;
}Example Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchTransactionsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<SearchTransactionsResult>
<ErrorsCount>0</ErrorsCount>
<TransactionsMatched>1</TransactionsMatched>
<Transactions>
<TransactionObject>
<DateTime>2025-10-30 11:36:09</DateTime>
<Source>econnect admin portal</Source>
<ShippingAddress>
<City/>
<Company/>
<Country/>
<Email/>
<Fax/>
<FirstName/>
<LastName/>
<Phone/>
<State/>
<Street/>
<Street2/>
<Zip/>
</ShippingAddress>
<ServerIP>11.11.111.111</ServerIP>
<Response>
<CustNum>19558221</CustNum>
<ResultCode>A</ResultCode>
<Result>Approved</Result>
<RemainingBalance>0</RemainingBalance>
<RefNum>******7248</RefNum>
<isDuplicate>false</isDuplicate>
<ErrorCode>0</ErrorCode>
<Error>Approved</Error>
<ConvertedAmountCurrency/>
<ConvertedAmount>0</ConvertedAmount>
<ConversionRate>0</ConversionRate>
<CardCodeResultCode>M</CardCodeResultCode>
<CardCodeResult>Match</CardCodeResult>
<BatchRefNum>498276</BatchRefNum>
<BatchNum>1509</BatchNum>
<AvsResultCode>YYY</AvsResultCode>
<AvsResult>Address: Match & 5 Digit Zip: Match</AvsResult>
<AuthCode>***253</AuthCode>
<AuthAmount>50</AuthAmount>
<Status>Settled</Status>
<StatusCode>S</StatusCode>
</Response>
<LineItems>
<LineItem>
<DiscountRate>0.000</DiscountRate>
<SKU>Invoice-106</SKU>
<CommodityCode>100001</CommodityCode>
<ProductName>Product</ProductName>
<Description>Description</Description>
<DiscountAmount>0.00</DiscountAmount>
<TaxRate>0.000</TaxRate>
<UnitOfMeasure>EA</UnitOfMeasure>
<UnitPrice>50.00</UnitPrice>
<Qty>1.0000</Qty>
<Taxable>false</Taxable>
<TaxAmount>0.00</TaxAmount>
</LineItem>
</LineItems>
<Details>
<NonTax>false</NonTax>
<Tax>0</Tax>
<Table/>
<Subtotal>0</Subtotal>
<Shipping>0</Shipping>
<ShipFromZip>92618</ShipFromZip>
<PONum>PO-123</PONum>
<OrderID>ORD-001</OrderID>
<Invoice>Invoice-106</Invoice>
<Duty>0</Duty>
<Discount>0</Discount>
<Comments/>
<Description>Inv#: Invoice-106</Description>
<Currency/>
<Clerk>techPubsAdmin</Clerk>
<Amount>50</Amount>
<AllowPartialAuth>false</AllowPartialAuth>
<Terminal>EBizCharge Admin Portal</Terminal>
<Tip>0</Tip>
</Details>
<User/>
<CustomFields/>
<CustomerID>Cbs0001</CustomerID>
<CreditCardData>
<Pares/>
<MagSupport/>
<MagStripe/>
<InternalCardAuth>false</InternalCardAuth>
<CardType>V</CardType>
<CardPresent>false</CardPresent>
<CardNumber>XXXXXXXXXXXX2224</CardNumber>
<CardExpiration>XXXX</CardExpiration>
<CardCode>XXX</CardCode>
<AvsZip>92618</AvsZip>
<AvsStreet>Century</AvsStreet>
<TermType/>
</CreditCardData>
<ClientIP>11.11.11.11</ClientIP>
<CheckTrace/>
<CheckData/>
<BillingAddress>
<City>Irvine</City>
<Company/>
<Country/>
<Email/>
<Fax/>
<FirstName/>
<LastName/>
<Phone/>
<State>CA</State>
<Street>20 Pacifica</Street>
<Street2/>
<Zip>92618</Zip>
</BillingAddress>
<AccountHolder>Test er</AccountHolder>
<Status>Settled</Status>
<TransactionType>Sale</TransactionType>
</TransactionObject>
</Transactions>
<SalesCount>1</SalesCount>
<SalesAmount>50</SalesAmount>
<Limit>1</Limit>
<VoidsCount>0</VoidsCount>
<ErrorsAmount>0</ErrorsAmount>
<DeclinesCount>0</DeclinesCount>
<DeclinesAmount>0</DeclinesAmount>
<CreditsCount>0</CreditsCount>
<CreditsAmount>0</CreditsAmount>
<AuthOnlyCount>0</AuthOnlyCount>
<AuthOnlyAmount>0</AuthOnlyAmount>
<TransactionsReturned>1</TransactionsReturned>
<VoidsAmount>0</VoidsAmount>
</SearchTransactionsResult>
</SearchTransactionsResponse>
</s:Body>
</s:Envelope><s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchTransactionsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<SearchTransactionsResult>
<SalesAmount>0</SalesAmount>
<ErrorsAmount>0</ErrorsAmount>
<DeclinesAmount>0</DeclinesAmount>
<CreditsAmount>0</CreditsAmount>
<AuthOnlyAmount>0</AuthOnlyAmount>
<VoidsAmount>0</VoidsAmount>
</SearchTransactionsResult>
</SearchTransactionsResponse>
</s:Body>
</s:Envelope>Updated 4 months ago