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.

See also runBatchUpload, getBatchUploadStatus, createBatchUpload

Syntax

boolean pauseBatchUpload ( ueSecurityToken Token, string UploadRefNum )

Arguments

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

Return Value

Type	Description
boolean	Returns confirmation of request only if 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.

    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

For directions on how to set up the WSDL link and create the "token" and "client" variables, go to the C Sharp .Net Soap How-to.

    string uploadrefnum = "1137";

                Boolean res;

                try
                {
                    res = client.pauseBatchUpload(token, uploadrefnum);
                    MessageBox.Show(string.Concat(res));
                }

                catch (Exception err)
                {
                    MessageBox.Show(err.Message);
                }

XML

Request:

    <?xml version="1.0" encoding="UTF-8"?>
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="urn:newtek"
    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:pauseBatchUpload>
    <Token xsi:type="ns1:ueSecurityToken">
    <ClientIP xsi:type="xsd:string">123.123.123.123</ClientIP>
    <PinHash xsi:type="ns1:ueHash">
    <HashValue xsi:type="xsd:string">7a4753dd5d3f191ce5ab702f466e9c64c05baddb</HashValue>
    <Seed xsi:type="xsd:string">11269237216-test</Seed>
    <Type xsi:type="xsd:string">sha1</Type>
    </PinHash>
    <SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
    </Token>
    <UploadRefNum xsi:type="xsd:string">73</UploadRefNum>
    </ns1:pauseBatchUpload>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>         

Response:

    <?xml version="1.0" encoding="utf-8"?>
    <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="urn:newtek"
    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:pauseBatchUploadResponse>
    <pauseBatchUploadReturn xsi:type="xsd:boolean">true</pauseBatchUploadReturn>
    </ns1:pauseBatchUploadResponse>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

Change Log

Version	Change
1.7	Changed UploadRefNum to type string