Soap API v1.2


Pause a Batch Upload that is already running.


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.

See also runBatchUpload, getBatchUploadStatus, createBatchUpload


boolean pauseBatchUpload ( ueSecurityToken Token, integer UploadRefNum )


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.



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

try { 
catch(SoapFault $e) { 
  echo $e->getMessage(); 
  echo "\n\nRequest: " . $tran->__getLastRequest(); 
  echo "\n\nResponse: " . $tran->__getLastResponse(); 

Change History

Version Change
1.2 Renamed BatchNum parameter to UploadRefNum
1.1 Soap 1.1 Release
developer/soap/methods/pausebatchupload.txt · Last modified: 2009/07/24 17:22 by tem

Page Tools