GetBatchStatus

Description

This method is used to get the status of a specified batch.

Syntax

BatchStatus GetBatchStatus(SecurityToken securityToken, String batchId)

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
String	batchId	The batchId of the batch to retrieve the status for. (required) Note: Passing a batchId of '0' will retrieve the status of the currently open batch.

Return Value

Type	Description
BatchStatus	Returns the batch status of the requested batchId.

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetBatchStatus>
         <ebiz:securityToken>
            <ebiz:SecurityId>*******-4963-4020-a53f-********</ebiz:SecurityId>
            <ebiz:UserId>?</ebiz:UserId>
            <ebiz:Password>?</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:batchId>0</ebiz:batchId>
      </ebiz:GetBatchStatus>
   </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">
      <GetBatchStatusResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetBatchStatusResult>
            <SalesAmount>4281</SalesAmount>
            <BatchRefNum>0</BatchRefNum>
            <Closed>06/16/2022T09:09:13</Closed>
            <CreditsAmount>12</CreditsAmount>
            <CreditsCount>1</CreditsCount>
            <NetAmount>4269</NetAmount>
            <Opened>06/14/2022T04:28:50</Opened>
            <VoidsCount>3</VoidsCount>
            <SalesCount>17</SalesCount>
            <Scheduled/>
            <Sequence>1609</Sequence>
            <Status>Closed</Status>
            <TransactionCount>21</TransactionCount>
            <VoidsAmount>151.05</VoidsAmount>
         </GetBatchStatusResult>
      </GetBatchStatusResponse>
   </s:Body>
</s:Envelope>