getBatchStatus

Retrieves the status of a batch specified by its BatchRefNum.

Description

This method will check on the status of any batch within the merchant console. Enter the BatchRefNum (a unique batch reference number assigned by the gateway) into the search field and the method will return the status of the requested batch.

To pull the status of the currently open batch (which has not yet passed to the gateway), use 0 for the the BatchRefNum.

Syntax

BatchStatus getBatchStatus ( ueSecurityToken Token, integer BatchRefNum )

Arguments

Type	Name	Description
ueSecurityToken	Token	Merchant security token: used to identify merchant and validate transaction.
integer	BatchRefNum	A unique batch reference number assigned by the gateway.

Return Value

BatchStatus

This method returns a BatchStatus object which includes information about the requested batch including BatchRefNum (if assigned), batch sequence, status (open, closing, or closed) dates and times when the batch was opened and closed, sales count, credit count, total settled amount and other pertinent details.

Examples

PHP

<?php

try {

$BatchRefNum=0;

$Result=$client->getBatchStatus($token, $BatchRefNum);

}

catch (SoapFault $e) {

echo "get Batch Upload status failed :" .$e->getMessage();

}

Java

try {

//Set BatchNum to the Batch Reference Number of the batch

//you want to retrieve. 0 is always the current batch

BigInteger BatchNum = new BigInteger("0");

BatchStatus batchstat = new BatchStatus();

batchstat = client.getBatchStatus(token, BigInteger.ZERO);

} catch (Exception e) {

System.out.println("Soap Exception: " + e.getMessage());

}

.NET VB

Dim BatchRefNum As String

BatchRefNum = "9581"

Dim result as eBizCharge.BatchStatus = New eBizCharge.BatchStatus

result = client.getBatchStatus(token, BatchRefNum)

MsgBox(result.Status)

.NET C#

string BatchRefNum;

BatchRefNum = "9581";

eBizCharge.BatchStatus result = new eBizCharge.BatchStatus();

try

{

result = client.getBatchStatus(token, BatchRefNum);

MessageBox.Show(string.Concat(result.Status));

}

catch (Exception err)

{

MessageBox.Show(err.Message);

}

XML

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:ns1="urn:eBizCharge" 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:getBatchStatus>

</PinHash>

<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>

</Token>

</ns1:getBatchStatus>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>