developer:soap-1.3:methods:runbatchupload

Soap API v1.3

runBatchUpload

Resume processing a paused batch upload.

Description

This method will resume uploading a batch that has been paused and send it to the gateway for processing.

For more information about uploading batches to the gateway for processing, please refer to documentation of the createBatchUpload method.

See also pauseBatchUpload, getBatchUploadStatus, createBatchUpload

Syntax

boolean runBatchUpload ( 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

boolean Returns confirmation of request only if request is successful. If request fails, an exception will be thrown.

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->runBatchUpload($token,$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 Boolean
        res = client.runBatchUpload(token, uploadrefnum)
        MsgBox(res)

.NET C#

string uploadrefnum = "1137";
 
            Boolean res;
 
            try 
            {
                res = client.runBatchUpload(token, uploadrefnum);
                MessageBox.Show(string.Concat(res));
            }
 
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
            }

Change History

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

Page Tools