developer:soap-1.3:methods:getbatchuploadstatus

Soap API v1.3

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.

See also pauseBatchUpload, runBatchUpload, createBatchUpload, getBatchStatus

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

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?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 usaepay.BatchUploadStatus = New usaepay.BatchUploadStatus
        res = client.getBatchUploadStatus(token, uploadrefnum)
        MsgBox(res.Status)

.NET C#

string uploadrefnum = "1137";
 
            usaepay.BatchUploadStatus res = new usaepay.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:usaepay" 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> 
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>
<Seed xsi:type="xsd:string">12678150211876663375</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
<UploadRefNum xsi:type="xsd:integer">288</UploadRefNum> 
</ns1:getBatchUploadStatus> 
</SOAP-ENV:Body> 
</SOAP-ENV:Envelope>

Change History

Version Change
1.2 Renamed BatchNum parameter to UploadRefNum
1.1 Soap 1.1 Release
developer/soap-1.3/methods/getbatchuploadstatus.txt · Last modified: 2010/10/05 14:41 by irina

Page Tools