EBizCharge Connect

EBizCharge Connect Developer Hub

Welcome to the EBizCharge Connect developer hub. You'll find comprehensive guides and documentation to help you start working with eBizCharge Connect as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    

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( SecurityToken securityToken, SearchFilter [] filters, bool matchAll, bool countOnly, string start, string limit, string sort)

Arguments

Type
Name
Description

securityToken

Merchant security token: used to identify merchant and validate transaction.

filters

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.

bool

countOnly

if set to "true", only transaction counts 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

Max number of batches to return in result set.

string

sort

Field name to sort the results by.

Return Value

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

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchBatches>
         <ebiz:securityToken>
            <ebiz:SecurityId>1DC496D1-90B4-4A38-AD78-28A795AF78E9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:filters>
            <ebiz:SearchFilter>
               <ebiz:FieldName>closed</ebiz:FieldName>
               <ebiz:ComparisonOperator>gt</ebiz:ComparisonOperator>
               <ebiz:FieldValue>2017-12-01</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:matchAll>false</ebiz:matchAll>
         <ebiz:countOnly>false</ebiz:countOnly>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort>closed</ebiz:sort>
      </ebiz:SearchBatches>
   </soapenv:Body>
</soapenv:Envelope>


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">
      <SearchBatchesResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchBatchesResult>
            <Batches>
               <BatchStatus>
                  <SalesAmount>2835.37</SalesAmount>
                  <BatchRefNum>321221</BatchRefNum>
                  <Closed>12/04/2017T11:50:00</Closed>
                  <CreditsAmount>20</CreditsAmount>
                  <CreditsCount>1</CreditsCount>
                  <NetAmount>2815.37</NetAmount>
                  <Opened>11/29/2017T13:35:41</Opened>
                  <VoidsCount>11</VoidsCount>
                  <SalesCount>19</SalesCount>
                  <Scheduled/>
                  <Sequence>411</Sequence>
                  <Status>Closed</Status>
                  <TransactionCount>31</TransactionCount>
                  <VoidsAmount>61</VoidsAmount>
               </BatchStatus>
               <BatchStatus>
                  <SalesAmount>6399.35</SalesAmount>
                  <BatchRefNum>321575</BatchRefNum>
                  <Closed>12/08/2017T09:47:31</Closed>
                  <CreditsAmount>20</CreditsAmount>
                  <CreditsCount>1</CreditsCount>
                  <NetAmount>6379.35</NetAmount>
                  <Opened>12/04/2017T12:57:38</Opened>
                  <VoidsCount>21</VoidsCount>
                  <SalesCount>47</SalesCount>
                  <Scheduled/>
                  <Sequence>809</Sequence>
                  <Status>Closed</Status>
                  <TransactionCount>70</TransactionCount>
                  <VoidsAmount>738.55</VoidsAmount>
               </BatchStatus>
            </Batches>
            <BatchesMatched>24</BatchesMatched>
            <BatchesReturned>2</BatchesReturned>
            <Limit>2</Limit>
            <StartIndex>0</StartIndex>
         </SearchBatchesResult>
      </SearchBatchesResponse>
   </s:Body>
</s:Envelope>

SearchBatches


Search previously settled batches.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.