pauseBatchUpload

Parent Previous Next

pauseBatchUpload

Pause a Batch Upload that is already running.

 

Description

This method pauses the gateway processing of a batch that is being uploaded. Pausing a currently running batch until the upload has been completed allows for time to double check transactions and confirm the gateway processing of the batch before sending it to the gateway.

Use the runBatchUpload method to resume gateway processing of the batch.

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

 

Syntax

boolean pauseBatchUpload ( ueSecurityToken Token, integer UploadRefNum )

 

Arguments

Type

Name

Description

ueSecurityToken

Token

Merchant security token: used to identify merchant and validate transaction.

integer

UploadRefNum

A unique batch reference number assigned by the gateway.

 

Return Value

boolean

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

 

Examples

 

PHP

 

<?php

try {

 $uploadrefnum='127';

 print_r($tran->pauseBatchUpload($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.pauseBatchUpload(token, uploadrefnum)

       MsgBox(res)

 

 

.NET C#

 

string uploadrefnum = "1137";

           Boolean res;

           try

           {

               res = client.pauseBatchUpload(token, uploadrefnum);

               MessageBox.Show(string.Concat(res));

           }

           catch (Exception err)

           {

               MessageBox.Show(err.Message);

           }

: