getBatchUploadStatus

Retrieve the status of a currently running batch.

Description

This method allows you to retrieve the status of a currently running batch.

This method is useful in determining whether a batch has been submitted to the gateway for processing, has been paused or is waiting to be uploaded.

To retrieve the status of batches other than the currently running batch, use the getBatchStatus method.

Syntax

BatchUploadStatus getBatchUploadStatus ( ueSecurityToken Token, integer UploadRefNum )

Arguments

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

Return Value

BatchUploadStatus

Returns the status of the currently running batch. Possible results include: open, closing, closed.

Examples

PHP

<?php

try {

$uploadrefnum='127';

print_r($tran->getBatchUploadStatus($sourcekey,$uploadrefnum));

}

catch(SoapFault $e) {

echo $e->getMessage();

echo "\n\nRequest: " . $tran->__getLastRequest();

echo "\n\nResponse: " . $tran->__getLastResponse();

}

.NET VB

Dim uploadrefnum As String

uploadrefnum = "1169"

Dim res As eBizCharge.BatchUploadStatus = New eBizCharge.BatchUploadStatus

res = client.getBatchUploadStatus(token, uploadrefnum)

MsgBox(res.Status)

.NET C#

string uploadrefnum = "1137";

eBizCharge.BatchUploadStatus res = new eBizCharge.BatchUploadStatus();

try

{

res = client.getBatchUploadStatus(token, uploadrefnum);

MessageBox.Show(string.Concat(res.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:getBatchUploadStatus>

</PinHash>

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

</Token>

</ns1:getBatchUploadStatus>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>