{"_id":"5632a5e949e16d0d0012247f","project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"__v":0,"category":{"_id":"5632a5e749e16d0d00122447","__v":1,"pages":["5632a5e949e16d0d0012247d","5632a5e949e16d0d0012247e","5632a5e949e16d0d0012247f","5632a5e949e16d0d00122480"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-03T18:03:20.852Z","from_sync":false,"order":5,"slug":"bulk-transaction-uploads","title":"Bulk Transaction Uploads"},"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:09:41.188Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Pause a Batch Upload that is already running.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis 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.\nUse the [runBatchUpload](/docs/runbatchupload) method to resume gateway processing of the batch.\nFor more information about uploading batches to the gateway for processing, please refer to documentation of the [createBatchUpload](/docs/createbatchupload) method.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nboolean **pauseBatchUpload** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer UploadRefNum )\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"boolean\",\n    \"0-1\": \"Returns confirmation of request only if successful. If request fails, an exception will be thrown.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ntry {\\n $uploadrefnum='127';\\n print_r($tran->pauseBatchUpload($token,$uploadrefnum));\\n}\\ncatch(SoapFault $e) {\\n echo $e->getMessage();\\n echo \\\"\\\\n\\\\nRequest: \\\" . $tran->__getLastRequest();\\n echo \\\"\\\\n\\\\nResponse: \\\" . $tran->__getLastResponse();\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim uploadrefnum As String\\n       uploadrefnum = \\\"1169\\\"\\n       Dim res As Boolean\\n       res = client.pauseBatchUpload(token, uploadrefnum)\\n       MsgBox(res)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string uploadrefnum = \\\"1137\\\";\\n           Boolean res;\\n           try\\n           {\\n               res = client.pauseBatchUpload(token, uploadrefnum);\\n               MessageBox.Show(string.Concat(res));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"pausebatchupload","type":"basic","title":"pauseBatchUpload"}
Pause a Batch Upload that is already running. [block:api-header] { "type": "basic", "title": "Description" } [/block] 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](/docs/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](/docs/createbatchupload) method. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] boolean **pauseBatchUpload** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer UploadRefNum ) [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "boolean", "0-1": "Returns confirmation of request only if successful. If request fails, an exception will be thrown." }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $uploadrefnum='127';\n print_r($tran->pauseBatchUpload($token,$uploadrefnum));\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n echo \"\\n\\nRequest: \" . $tran->__getLastRequest();\n echo \"\\n\\nResponse: \" . $tran->__getLastResponse();\n}\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim uploadrefnum As String\n uploadrefnum = \"1169\"\n Dim res As Boolean\n res = client.pauseBatchUpload(token, uploadrefnum)\n MsgBox(res)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string uploadrefnum = \"1137\";\n Boolean res;\n try\n {\n res = client.pauseBatchUpload(token, uploadrefnum);\n MessageBox.Show(string.Concat(res));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block]