SearchApplicationTransactions

Description

The SearchApplicationTransactions method retrieves application transactions.

Syntax

ApplicationTransactionSearchResult SearchApplicationTransactions(SecurityToken securityToken, SearchFilter[] filters, boolean countOnly, int start, int limit, string sort)

Arguments

Type

Name

Req.

Description

SecurityToken

securityToken

R

A unique token that is used to identify a merchant and authenticate the API request.

SearchFilter[]

filters

O

Filters ApplicationTransactionDetails objects based on one or more field names, comparison operators, and field values. See supported search parameters below.

boolean

countOnly

R

Whether the response should include only the total count of matching objects, excluding the objects themselves.

int

start

R

Index of the first object to return in the array.

Note: Must be ≥ 0.

int

limit

R

Maximum number of objects to return.

Note: Must be > 0.

string

sort

O

Sorts by field name.

Supported Sort Parameters
  • TransactionId
  • TransactionTypeId
  • LinkedToTypeId
  • LinkedToExternalUniqueId
  • TransactionDate
  • TransactionAmount
  • PaymentMethodType

Return Value

TypeDescription
ApplicationTransactionSearchResultReturns a list of ApplicationTransactionDetails objects that match the search criteria. Otherwise, an empty list is returned.

Supported Search Parameters

<ebiz:SearchFilter>  <ebiz:FieldName>ApplicationTransactionInternalId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>*******ff0-85bb-3********</ebiz:FieldValue> </ebiz:SearchFilter>

ParameterDescriptionExample of Use
ApplicationTransactionInternalIdFilters by the internal ID of the application transaction.
CustomerInternalIdFilters by the internal ID of the customer.

<ebiz:SearchFilter>  <ebiz:FieldName>CustomerInternalId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>*******45de-82b73*******5</ebiz:FieldValue> </ebiz:SearchFilter>

TransactionIdFilters by transaction ID.

<ebiz:SearchFilter>  <ebiz:FieldName>TransactionId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>3218815929</ebiz:FieldValue> </ebiz:SearchFilter>

TransactionTypeIdFilters by transaction type.

<ebiz:SearchFilter>  <ebiz:FieldName>TransactionTypeId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>Sale</ebiz:FieldValue> </ebiz:SearchFilter>

LinkedToTypeIdFilters by ID of the TransactionTypeID.

<ebiz:SearchFilter>  <ebiz:FieldName>LinkedToTypeId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>649</ebiz:FieldValue> </ebiz:SearchFilter>

LinkedToInternalIdFilters by the internal ID of the TransactionTypeID.

<ebiz:SearchFilter>  <ebiz:FieldName>LinkedToInternalId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>******424758347568****</ebiz:FieldValue> </ebiz:SearchFilter>

LinkedToExternalUniqueIdFilters by the external ID of the TransactionTypeID.

<ebiz:SearchFilter>  <ebiz:FieldName>LinkedToExternalUniqueId</ebiz:FieldName>  <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>  <ebiz:FieldValue>648</ebiz:FieldValue> </ebiz:SearchFilter>

TransactionDateFilters by the date the transaction was created.

<ebiz:SearchFilter>  <ebiz:FieldName>TransactionDate</ebiz:FieldName>  <ebiz:ComparisonOperator>ne</ebiz:ComparisonOperator>  <ebiz:FieldValue>2025-11-10</ebiz:FieldValue> </ebiz:SearchFilter>

TransactionAmountFilters by transaction amount.

<ebiz:SearchFilter>   <ebiz:FieldName>TransactionAmount</ebiz:FieldName>   <ebiz:ComparisonOperator>ne</ebiz:ComparisonOperator>   <ebiz:FieldValue>5.0000</ebiz:FieldValue> </ebiz:SearchFilter>

TransactionNotesFilters by the notes on the transaction.

<ebiz:SearchFilter>  <ebiz:FieldName>TransactionNotes</ebiz:FieldName>  <ebiz:ComparisonOperator>ne</ebiz:ComparisonOperator>  <ebiz:FieldValue>BigCommerce</ebiz:FieldValue> </ebiz:SearchFilter>


Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchApplicationTransactions>
         <ebiz:securityToken>
            <ebiz:SecurityId>**********0-91cd-95ccd********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:filters>
         <!--Zero or more repetitions:-->
            <ebiz:SearchFilter>
               <ebiz:FieldName>TransactionDate</ebiz:FieldName>
               <ebiz:ComparisonOperator>gt</ebiz:ComparisonOperator>
               <ebiz:FieldValue>2022-12-05</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:countOnly>false</ebiz:countOnly>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
      </ebiz:SearchApplicationTransactions>
   </soapenv:Body>
</soapenv:Envelope>
public void SearchApplicationTransactions()
{
  eBizService apiClient = new eBizService();
  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = "*******-c870-41b8-aa5c-********",
    UserId = "",
    Password = ""
    };
  //Declare the Array of searchfilters
  SearchFilter[] searchFilters = new SearchFilter[1];
  //Declare a SearchFilter
  SearchFilter searchFilter = new SearchFilter();
  searchFilter.FieldName = "DateUploaded";
  searchFilter.ComparisonOperator = "gt";
  searchFilter.FieldValue = "04/01/2022";
  //Add SearchFilter to Array for SearchFilters
  searchFilters[0] = searchFilter;
  var response = apiClient.SearchApplicationTransactions(securityToken,searchFilters,false,0,100,"");
  Console.WriteLine(response.Count);
  Console.ReadLine();
}
public function SearchApplicationTransactions()
{
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '******-454757-4567457-********',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );
  $response = $this->soapClient->SearchApplicationTransactions(
    array(
      'securityToken' => $securityToken,
      'countOnly' => false,
      'start' => 0,
      'limit' => 1000,
    )
  );
  $result = $response->SearchApplicationTransactionsResult;
}

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">
      <SearchApplicationTransactionsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchApplicationTransactionsResult>
            <ApplicationTransactions>
               <ApplicationTransactionDetails>
                  <ApplicationTransactionInternalId>********88a6-423*******</ApplicationTransactionInternalId>
                  <CustomerInternalId>*************de-82b7-789>*************</CustomerInternalId>
                  <TransactionId>*****3508</TransactionId>
                  <TransactionTypeId>Auth Only</TransactionTypeId>
                  <SoftwareId/>
                  <LinkedToTypeId>645</LinkedToTypeId>
                  <LinkedToInternalId>*************-4f5d-83eb-9*************</LinkedToInternalId>
                  <LinkedToExternalUniqueId>645</LinkedToExternalUniqueId>
                  <TransactionDate>2025-11-10</TransactionDate>
                  <TransactionNotes>BigCommerce</TransactionNotes>
                  <TransactionExternalReferenceNumber/>
                  <TransactionCustomFields/>
                  <TransactionAmount>23.1800</TransactionAmount>
                  <IsTransactionApplied>false</IsTransactionApplied>
                  <PaymentMethodLast4>1111</PaymentMethodLast4>
                  <PaymentMethodType>Visa</PaymentMethodType>
               </ApplicationTransactionDetails>
               <ApplicationTransactionDetails>
                  <ApplicationTransactionInternalId>******bce-45f2-9********</ApplicationTransactionInternalId>
                  <CustomerInternalId>>*************5de-82b7->*************</CustomerInternalId>
                  <TransactionId>********4177</TransactionId>
                  <TransactionTypeId>Auth Only</TransactionTypeId>
                  <SoftwareId/>
                  <LinkedToTypeId>***</LinkedToTypeId>
                  <LinkedToInternalId>*************fb3-a1a3-e61*************</LinkedToInternalId>
                  <LinkedToExternalUniqueId>646</LinkedToExternalUniqueId>
                  <TransactionDate>2025-11-10</TransactionDate>
                  <TransactionNotes>BigCommerce</TransactionNotes>
                  <TransactionExternalReferenceNumber/>
                  <TransactionCustomFields/>
                  <TransactionAmount>23.1800</TransactionAmount>
                  <IsTransactionApplied>false</IsTransactionApplied>
                  <PaymentMethodLast4>1111</PaymentMethodLast4>
                  <PaymentMethodType>Visa</PaymentMethodType>
               </ApplicationTransactionDetails>
            </ApplicationTransactions>
            <Start>1</Start>
            <Limit>2</Limit>
            <Count>2</Count>
         </SearchApplicationTransactionsResult>
      </SearchApplicationTransactionsResponse>
   </s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:Client</faultcode>
         <faultstring xml:lang="en-US">Error: Error</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>