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.

Syntax

boolean runBatchUpload ( ueSecurityToken Token, string UploadRefNum )

Arguments

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

Return Value

Type	Description
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

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.runBatchUpload(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:runBatchUpload>
    <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">fc4f9fa4f9681fde58ec6c1d92a3d221c9ffa9d3</HashValue>
    <Seed xsi:type="xsd:string">1333739462-test</Seed>
    <Type xsi:type="xsd:string">sha1</Type>
    </PinHash>
    <SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
    </Token>
    <UploadRefNum xsi:type="xsd:string">52</UploadRefNum>
    </ns1:runBatchUpload>
    </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:runBatchUploadResponse>
    <runBatchUploadReturn xsi:type="xsd:boolean">true</runBatchUploadReturn>
    </ns1:runBatchUploadResponse>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

Change History

Version	Change
1.7	Changed UploadRefNum to type string
1.2	Renamed BatchNum parameter to UploadRefNum
1.1	Soap 1.1 Release